Struct x11rb::protocol::shm::SegWrapper

pub struct SegWrapper<C: RequestConnection>(/* private fields */);

A RAII-like wrapper around a Seg.

Instances of this struct represent a Seg that is freed in Drop.

Any errors during Drop are silently ignored. Most likely an error here means that your X11 connection is broken and later requests will also fail.

Implementations

impl<C: RequestConnection> SegWrapper<C>

pub fn for_seg(conn: C, id: Seg) -> Self

Assume ownership of the given resource and destroy it in Drop.

pub fn seg(&self) -> Seg

Get the XID of the wrapped resource

pub fn into_seg(self) -> Seg

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

impl<'c, C: X11Connection> SegWrapper<&'c C>

pub fn attach_and_get_cookie( conn: &'c C, shmid: u32, read_only: bool ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

Create a new Seg and return a Seg wrapper and a cookie.

This is a thin wrapper around attach that allocates an id for the Seg. This function returns the resulting SegWrapper that owns the created Seg and frees it in Drop. This also returns a VoidCookie that comes from the call to attach.

Errors can come from the call to X11Connection::generate_id or attach.

impl<C: X11Connection> SegWrapper<C>

pub fn attach( conn: C, shmid: u32, read_only: bool ) -> Result<Self, ReplyOrIdError>

Create a new Seg and return a Seg wrapper

This is a thin wrapper around attach that allocates an id for the Seg. This function returns the resulting SegWrapper that owns the created Seg and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or attach.

impl<'c, C: X11Connection> SegWrapper<&'c C>

pub fn attach_fd_and_get_cookie<A>( conn: &'c C, shm_fd: A, read_only: bool ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

where A: Into<RawFdContainer>,

Create a new Seg and return a Seg wrapper and a cookie.

This is a thin wrapper around attach_fd that allocates an id for the Seg. This function returns the resulting SegWrapper that owns the created Seg and frees it in Drop. This also returns a VoidCookie that comes from the call to attach_fd.

Errors can come from the call to X11Connection::generate_id or attach_fd.

impl<C: X11Connection> SegWrapper<C>

pub fn attach_fd<A>( conn: C, shm_fd: A, read_only: bool ) -> Result<Self, ReplyOrIdError>

where A: Into<RawFdContainer>,

Create a new Seg and return a Seg wrapper

This is a thin wrapper around attach_fd that allocates an id for the Seg. This function returns the resulting SegWrapper that owns the created Seg and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or attach_fd.

Trait Implementations

impl<C: Debug + RequestConnection> Debug for SegWrapper<C>

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

Formats the value using the given formatter.

impl<C: RequestConnection> Drop for SegWrapper<C>

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&SegWrapper<C>> for Seg

fn from(from: &SegWrapper<C>) -> Self

Converts to this type from the input type.