Struct OptionalString 

pub struct OptionalString<'de> { /* private fields */ }

An optional FIDL string

Implementations

impl OptionalString<'_>

pub fn encode_present(out: &mut MaybeUninit<Self>, len: u64)

Encodes that a string is present in a slot.

pub fn encode_absent(out: &mut MaybeUninit<Self>)

Encodes that a string is absent in a slot.

pub fn is_some(&self) -> bool

Returns whether the optional string is present.

pub fn is_none(&self) -> bool

Returns whether the optional string is absent.

pub fn as_ref(&self) -> Option<&String<'_>>

Returns a reference to the underlying string, if any.

Trait Implementations

impl Constrained for OptionalString<'_>

type Constraint = u64

Type of constraint information for this type.

fn validate( slot: Slot<'_, Self>, constraint: Self::Constraint, ) -> Result<(), ValidationError>

Validate a slot of this type against a constraint. Can be called when pointers/envelopes are just presence markers.

impl Debug for OptionalString<'_>

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

Formats the value using the given formatter.

impl<'de, D: Decoder<'de> + ?Sized> Decode<D> for OptionalString<'de>

fn decode( slot: Slot<'_, Self>, decoder: &mut D, constraint: u64, ) -> Result<(), DecodeError>

Decodes a value into a slot using a decoder.

impl<E: Encoder + ?Sized> EncodeOption<OptionalString<'static>, E> for &String

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<OptionalString<'static>>, constraint: u64, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E: Encoder + ?Sized> EncodeOption<OptionalString<'static>, E> for &str

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<OptionalString<'static>>, _constraint: u64, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl<E: Encoder + ?Sized> EncodeOption<OptionalString<'static>, E> for String

fn encode_option( this: Option<Self>, encoder: &mut E, out: &mut MaybeUninit<OptionalString<'static>>, constraint: u64, ) -> Result<(), EncodeError>

Encodes this optional value into an encoder and output.

impl FromWireOption<OptionalString<'_>> for String

fn from_wire_option(wire: OptionalString<'_>) -> Option<Self>

Converts the given owned value to an option of this type.

impl FromWireOptionRef<OptionalString<'_>> for String

fn from_wire_option_ref(wire: &OptionalString<'_>) -> Option<Self>

Converts the given reference to an option of this type.

impl IntoNatural for OptionalString<'_>

type Natural = Option<String>

A good default type for this wire type to convert into.

fn into_natural(self) -> Self::Natural

Converts this type into its natural equivalent.

impl<T> PartialEq<Option<T>> for OptionalString<'_>

where for<'de> String<'de>: PartialEq<T>,

fn eq(&self, other: &Option<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Wire for OptionalString<'static>

type Narrowed<'de> = OptionalString<'de>

The narrowed wire type, restricted to the 'de lifetime.

fn zero_padding(out: &mut MaybeUninit<Self>)

Writes zeroes to the padding for this type, if any.