Struct gpapi::SingularPtrField

pub struct SingularPtrField<T> { /* fields omitted */ }

Like Option<Box<T>>, but keeps the actual element on clear.

Methods

impl<T> SingularPtrField<T>

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

Construct SingularPtrField from given object.

pub fn none() -> SingularPtrField<T>

Construct an empty SingularPtrField.

pub fn from_option(option: Option<T>) -> SingularPtrField<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(&'a self) -> Option<&'a T>

View data as reference option.

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

View data as mutable reference option.

pub fn get_ref(&'a self) -> &'a T

Get data as reference. Panics if empty.

pub fn get_mut_ref(&'a mut self) -> &'a mut T

Get data as mutable reference. Panics if empty.

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) -> SingularPtrField<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(&'a self) -> IntoIter<&'a T>

View data as iterator.

pub fn mut_iter(&'a mut self) -> IntoIter<&'a 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> SingularPtrField<T> where
    T: Clear + Default, 

pub fn unwrap_or_default(self) -> T

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

pub fn set_default(&'a mut self) -> &'a mut T

Trait Implementations

impl<T> Hash for SingularPtrField<T> where
    T: Hash, 

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, 

Feeds a slice of this type into the given [Hasher].

impl<T> Default for SingularPtrField<T>

fn default() -> SingularPtrField<T>

Returns the "default value" for a type.

impl<T> From<Option<T>> for SingularPtrField<T>

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

Performs the conversion.

impl<M> MessageField<M> for SingularPtrField<M> where
    M: Message + Default, 

fn get_message(&self) -> &M

Get a message reference or default instance.

fn mut_message(&mut self) -> &mut M

Get a message reference, and initialize field with empty message if field is not yet initialized.

fn set_message(&mut self, message: M)

Set message to the field.

fn set_default(&mut self) -> &mut M

Set message field to default value.

impl<'a, T> IntoIterator for &'a SingularPtrField<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> Eq for SingularPtrField<T> where
    T: Eq, 

impl<T> Serialize for SingularPtrField<T> where
    T: Serialize, 

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<T> PartialEq<SingularPtrField<T>> for SingularPtrField<T> where
    T: PartialEq<T>, 

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

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

#[must_use]

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

This method tests for !=.

impl<'de, T> Deserialize<'de> for SingularPtrField<T> where
    T: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<T> Clone for SingularPtrField<T> where
    T: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for SingularPtrField<T> where
    T: Debug, 

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

Formats the value using the given formatter.