Struct protobuf::MessageField

pub struct MessageField<T>(pub Option<Box<T>>);

Wrapper around Option<Box<T>>, convenient newtype.

Examples

let mut customer = Customer::new();

// field of type `SingularPtrField` can be initialized like this
customer.address = MessageField::some(make_address());
// or using `Option` and `Into`
customer.address = Some(make_address()).into();

Tuple Fields

0: Option<Box<T>>

Implementations

impl<T> MessageField<T>

pub fn some(value: T) -> MessageField<T>

Construct SingularPtrField from given object.

pub const fn none() -> MessageField<T>

Construct an empty SingularPtrField.

pub fn from_option(option: Option<T>) -> MessageField<T>

Construct SingularPtrField from optional.

pub fn is_some(&self) -> bool

True iff this object contains data.

pub fn is_none(&self) -> bool

True iff this object contains no data.

pub fn into_option(self) -> Option<T>

Convert into Option<T>.

pub fn as_ref(&self) -> Option<&T>

View data as reference option.

pub fn as_mut(&mut self) -> Option<&mut T>

View data as mutable reference option.

pub fn unwrap(self) -> T

Take the data. Panics if empty

pub fn unwrap_or(self, def: T) -> T

Take the data or return supplied default element if empty.

pub fn unwrap_or_else<F>(self, f: F) -> T

where F: FnOnce() -> T,

Take the data or return supplied default element if empty.

pub fn map<U, F>(self, f: F) -> MessageField<U>

where F: FnOnce(T) -> U,

Apply given function to contained data to construct another SingularPtrField. Returns empty SingularPtrField if this object is empty.

pub fn iter(&self) -> IntoIter<&T>

View data as iterator.

pub fn mut_iter(&mut self) -> IntoIter<&mut T>

View data as mutable iterator.

pub fn take(&mut self) -> Option<T>

Take data as option, leaving this object empty.

pub fn clear(&mut self)

Clear this object, but do not call destructor of underlying data.

impl<T: Default> MessageField<T>

pub fn unwrap_or_default(self) -> T

Get contained data, consume self. Return default value for type if this is empty.

impl<M: Message> MessageField<M>

pub fn get_or_default(&self) -> &M

Get a reference to contained value or a default instance.

pub fn mut_or_insert_default(&mut self) -> &mut M

Get a mutable reference to contained value, initialize if not initialized yet.

Trait Implementations

impl<T: Clone> Clone for MessageField<T>

fn clone(&self) -> MessageField<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for MessageField<T>

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

Formats the value using the given formatter.

impl<T> Default for MessageField<T>

fn default() -> MessageField<T>

Returns the “default value” for a type.

impl<M: Message> Deref for MessageField<M>

Get a reference to contained value or a default instance if the field is not initialized.

type Target = M

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> From<Option<T>> for MessageField<T>

We don’t have From<Option<Box<T>>> for MessageField<T> because it would make type inference worse.

fn from(o: Option<T>) -> Self

Converts to this type from the input type.

impl<T: Hash> Hash for MessageField<T>

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<'a, T> IntoIterator for &'a MessageField<T>

type Item = &'a T

The type of the elements being iterated over.

type IntoIter = IntoIter<&'a T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<&'a T>

Creates an iterator from a value.

impl<T: PartialEq> PartialEq for MessageField<T>

fn eq(&self, other: &MessageField<T>) -> 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<T: Eq> Eq for MessageField<T>

impl<T> StructuralPartialEq for MessageField<T>