Struct base::descriptor::Descriptor

#[repr(transparent)]
pub struct Descriptor(pub RawDescriptor);

For use cases where a simple wrapper around a RawDescriptor is needed, in order to e.g. implement AsRawDescriptor.

This is a simply a wrapper and does not manage the lifetime of the descriptor. As such it is the responsibility of the user to ensure that the wrapped descriptor will not be closed for as long as the Descriptor is alive.

Most use-cases should prefer SafeDescriptor or implementing and using AsRawDescriptor on the type providing the descriptor. Using this wrapper usually means something can be improved in your code.

Valid uses of this struct include:

• You only have a valid RawDescriptor and need to pass something that implements AsRawDescriptor to a function,
• You need to serialize a RawDescriptor,
• You need Send or Sync for your descriptor and properly handle the case where your descriptor gets closed.

Note that with the exception of the last use-case (which requires proper error checking against the descriptor being closed), the Descriptor instance would be very short-lived.

Tuple Fields

0: RawDescriptor

Trait Implementations

impl AsRawDescriptor for Descriptor

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl AsRawFd for Descriptor

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Descriptor

fn deserialize<D>(deserializer: D) -> Result<Descriptor, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EventToken for Descriptor

Implement token for implementations that wish to use this struct as such

fn as_raw_token(&self) -> u64

Converts this token into a u64 that can be turned back into a token via from_raw_token.

fn from_raw_token(data: u64) -> Self

Converts a raw token as returned from as_raw_token back into a token.

impl FromRawDescriptor for Descriptor

unsafe fn from_raw_descriptor(desc: RawDescriptor) -> Self

Safety

impl Hash for Descriptor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Descriptor

fn cmp(&self, other: &Descriptor) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Descriptor

fn eq(&self, other: &Descriptor) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Descriptor

fn partial_cmp(&self, other: &Descriptor) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Descriptor

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Descriptor

impl Eq for Descriptor

impl StructuralPartialEq for Descriptor