Struct sunrise_libuser::vi::ViInterfaceProxy

pub struct ViInterfaceProxy(ClientSession);

Entry point interface.

Implementations

impl ViInterfaceProxy

pub fn raw_new() -> Result<ViInterfaceProxy, Error>

Creates a new ViInterfaceProxy by connecting to the vi: service.

pub fn new() -> Result<&'static ViInterfaceProxy, Error>

Acquires the shared handle to the vi: service - connecting if it wasn't already.

impl ViInterfaceProxy

pub fn clone_current_object(&self) -> Result<Self, Error>

Clones the current object, returning a new handle. The returned handle has its own IPC buffer - it may be used concurrently with the original.

pub fn create_buffer(
    &self,
    framebuffer: &SharedMemory,
    top: i32,
    left: i32,
    width: u32,
    height: u32
) -> Result<IBufferProxy, Error>

Create a window.

This creates a window at the given coordinates, with the given height. The passed handle should be a SharedMemory handle containing a framebuffer of type [[u8; width]; height].

It is allowed to place the framebuffer outside the field of view.

pub fn get_screen_resolution(&self) -> Result<(u32, u32), Error>

Gets the screen resolution.

pub fn get_font_height(&self) -> Result<u32, Error>

Gets the height of the font used for rendering a terminal line.

pub fn create_terminal(
    &self,
    framebuffer: &SharedMemory,
    top: i32,
    left: i32,
    width: u32,
    height: u32
) -> Result<IPipeProxy, Error>

Create a terminal.

This creates a terminal at the given coordinates, with the given height.

It is allowed to place the framebuffer outside the field of view.

Trait Implementations

impl Debug for ViInterfaceProxy

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl From<ClientSession> for ViInterfaceProxy

fn from(sess: ClientSession) -> ViInterfaceProxy

Performs the conversion.

impl From<ViInterfaceProxy> for ClientSession

fn from(sess: ViInterfaceProxy) -> ClientSession

Performs the conversion.