Struct x11rb::protocol::sync::FenceWrapper

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

A RAII-like wrapper around a Fence.

Instances of this struct represent a Fence 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> FenceWrapper<C>

pub fn for_fence(conn: C, id: Fence) -> Self

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

pub fn fence(&self) -> Fence

Get the XID of the wrapped resource

pub fn into_fence(self) -> Fence

Assume ownership of the XID of the wrapped resource

This function destroys this wrapper without freeing the underlying resource.

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

pub fn create_fence_and_get_cookie( conn: &'c C, drawable: Drawable, initially_triggered: bool ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

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

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

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

impl<C: X11Connection> FenceWrapper<C>

pub fn create_fence( conn: C, drawable: Drawable, initially_triggered: bool ) -> Result<Self, ReplyOrIdError>

Create a new Fence and return a Fence wrapper

This is a thin wrapper around create_fence that allocates an id for the Fence. This function returns the resulting FenceWrapper that owns the created Fence and frees it in Drop.

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

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

pub fn dri3_fence_from_fd_and_get_cookie<A>( conn: &'c C, drawable: Drawable, initially_triggered: bool, fence_fd: A ) -> Result<(Self, VoidCookie<'c, C>), ReplyOrIdError>

where A: Into<RawFdContainer>,

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

This is a thin wrapper around super::dri3::fence_from_fd that allocates an id for the Fence. This function returns the resulting FenceWrapper that owns the created Fence and frees it in Drop. This also returns a VoidCookie that comes from the call to super::dri3::fence_from_fd.

Errors can come from the call to X11Connection::generate_id or super::dri3::fence_from_fd.

impl<C: X11Connection> FenceWrapper<C>

pub fn dri3_fence_from_fd<A>( conn: C, drawable: Drawable, initially_triggered: bool, fence_fd: A ) -> Result<Self, ReplyOrIdError>

where A: Into<RawFdContainer>,

Create a new Fence and return a Fence wrapper

This is a thin wrapper around super::dri3::fence_from_fd that allocates an id for the Fence. This function returns the resulting FenceWrapper that owns the created Fence and frees it in Drop.

Errors can come from the call to X11Connection::generate_id or super::dri3::fence_from_fd.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn drop(&mut self)

Executes the destructor for this type.

impl<C: RequestConnection> From<&FenceWrapper<C>> for Fence

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

Converts to this type from the input type.