Enum Fd 

pub enum Fd<'f> {
    Borrowed(BorrowedFd<'f>),
    Owned(OwnedFd),
}

A file-descriptor type wrapper.

Since std::os::fd::BorrowedFd and std::os::fd::OwnedFd types do not implement Serialize and Deserialize. So we provide a wrapper for both that implements these traits.

D-Bus FD Encoding

In D-Bus, file descriptors are not encoded as their raw numeric values on the wire. Instead, the message body contains a u32 index into an out-of-band array of file descriptors that is transferred alongside the message via SCM_RIGHTS on Unix sockets.

The Deserialize implementation on this type is designed for zvariant’s D-Bus deserializer, which resolves that index through the message’s FD list before calling the serde visitor. Using this type with other deserializers (JSON, CBOR, etc.) is not supported — you would receive a BorrowedFd pointing to whatever FD number happened to be in the payload, which is almost certainly not what you want.

Variants

Borrowed(BorrowedFd<'f>)

Owned(OwnedFd)

Implementations

impl Fd<'_>

pub fn try_to_owned(&self) -> Result<Fd<'static>, Error>

Try to create an owned version of self.

pub fn try_clone(&self) -> Result<Fd<'_>, Error>

Try to clone self.

Trait Implementations

impl AsFd for Fd<'_>

fn as_fd(&self) -> BorrowedFd<'_>

Borrows the file descriptor.

impl AsRawFd for Fd<'_>

fn as_raw_fd(&self) -> i32

Extracts the raw file descriptor.

impl Basic for Fd<'_>

const SIGNATURE_CHAR: char = 'h'

The type signature, as a character.

const SIGNATURE_STR: &'static str = "h"

The type signature, as a string.

fn alignment(format: Format) -> usize

The required padding alignment for the given format.

impl<'f> Debug for Fd<'f>

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Fd<'de>

fn deserialize<D>( deserializer: D, ) -> Result<Fd<'de>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Fd<'_>

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

Formats the value using the given formatter.

impl Eq for Fd<'_>

impl<'fd, T> From<&'fd T> for Fd<'fd>

where T: AsFd,

fn from(t: &'fd T) -> Fd<'fd>

Converts to this type from the input type.

impl<'f> From<BorrowedFd<'f>> for Fd<'f>

fn from(fd: BorrowedFd<'f>) -> Fd<'f>

Converts to this type from the input type.

impl From<OwnedFd> for Fd<'_>

fn from(fd: OwnedFd) -> Fd<'_>

Converts to this type from the input type.

impl From<OwnedFd> for Fd<'_>

fn from(owned: OwnedFd) -> Fd<'_>

Converts to this type from the input type.

impl Hash for Fd<'_>

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

where H: Hasher,

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 Fd<'_>

fn cmp(&self, other: &Fd<'_>) -> 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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Fd<'_>

fn eq(&self, other: &Fd<'_>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Fd<'_>

fn partial_cmp(&self, other: &Fd<'_>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for Fd<'_>

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a OwnedValue> for &'a Fd<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( v: &'a OwnedValue, ) -> Result<&'a Fd<'a>, <&'a Fd<'a> as TryFrom<&'a OwnedValue>>::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Value<'_>> for &'a Fd<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: &'a Value<'_>, ) -> Result<&'a Fd<'a>, <&'a Fd<'a> as TryFrom<&'a Value<'_>>>::Error>

Performs the conversion.

impl<'a> TryFrom<&Value<'a>> for Fd<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: &Value<'a>, ) -> Result<Fd<'a>, <Fd<'a> as TryFrom<&Value<'a>>>::Error>

Performs the conversion.

impl TryFrom<OwnedValue> for Fd<'static>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( v: OwnedValue, ) -> Result<Fd<'static>, <Fd<'static> as TryFrom<OwnedValue>>::Error>

Performs the conversion.

impl<'a> TryFrom<Value<'a>> for Fd<'a>

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: Value<'a>, ) -> Result<Fd<'a>, <Fd<'a> as TryFrom<Value<'a>>>::Error>

Performs the conversion.

impl Type for Fd<'_>

const SIGNATURE: &'static Signature

The signature for the implementing type, in parsed format.