Struct bee_block::payload::OptionalPayload

pub struct OptionalPayload(_);

Representation of an optional Payload. Essentially an Option<Payload> with a different Packable implementation, to conform to specs.

Methods from Deref<Target = Option<Payload>>

pub fn is_some(&self) -> bool

Returns true if the option is a Some value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_some(), true);

let x: Option<u32> = None;
assert_eq!(x.is_some(), false);

pub fn is_some_and(&self, f: impl FnOnce(&T) -> bool) -> bool

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

Returns true if the option is a Some and the value inside of it matches a predicate.

Examples

#![feature(is_some_with)]

let x: Option<u32> = Some(2);
assert_eq!(x.is_some_and(|&x| x > 1), true);

let x: Option<u32> = Some(0);
assert_eq!(x.is_some_and(|&x| x > 1), false);

let x: Option<u32> = None;
assert_eq!(x.is_some_and(|&x| x > 1), false);

pub fn is_none(&self) -> bool

Returns true if the option is a None value.

Examples

let x: Option<u32> = Some(2);
assert_eq!(x.is_none(), false);

let x: Option<u32> = None;
assert_eq!(x.is_none(), true);

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

Converts from &Option<T> to Option<&T>.

Examples

Converts an Option<String> into an Option<usize>, preserving the original. The map method takes the self argument by value, consuming the original, so this technique uses as_ref to first take an Option to a reference to the value inside the original.

let text: Option<String> = Some("Hello, world!".to_string());
// First, cast `Option<String>` to `Option<&String>` with `as_ref`,
// then consume *that* with `map`, leaving `text` on the stack.
let text_length: Option<usize> = text.as_ref().map(|s| s.len());
println!("still can print text: {text:?}");

pub fn as_pin_ref(self: Pin<&Option<T>>) -> Option<Pin<&T>>

Converts from Pin<&Option<T>> to Option<Pin<&T>>.

pub fn as_pin_mut(self: Pin<&mut Option<T>>) -> Option<Pin<&mut T>>

Converts from Pin<&mut Option<T>> to Option<Pin<&mut T>>.

pub fn as_deref(&self) -> Option<&<T as Deref>::Target>where
    T: Deref,

Converts from Option<T> (or &Option<T>) to Option<&T::Target>.

Leaves the original Option in-place, creating a new one with a reference to the original one, additionally coercing the contents via Deref.

Examples

let x: Option<String> = Some("hey".to_owned());
assert_eq!(x.as_deref(), Some("hey"));

let x: Option<String> = None;
assert_eq!(x.as_deref(), None);

pub fn iter(&self) -> Iter<'_, T>

Returns an iterator over the possibly contained value.

Examples

let x = Some(4);
assert_eq!(x.iter().next(), Some(&4));

let x: Option<u32> = None;
assert_eq!(x.iter().next(), None);

pub fn contains<U>(&self, x: &U) -> boolwhere
    U: PartialEq<T>,

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

Returns true if the option is a Some value containing the given value.

Examples

#![feature(option_result_contains)]

let x: Option<u32> = Some(2);
assert_eq!(x.contains(&2), true);

let x: Option<u32> = Some(3);
assert_eq!(x.contains(&2), false);

let x: Option<u32> = None;
assert_eq!(x.contains(&2), false);

Trait Implementations

impl Clone for OptionalPayload

fn clone(&self) -> OptionalPayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptionalPayload

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

Formats the value using the given formatter.

impl Deref for OptionalPayload

type Target = Option<Payload>

The resulting type after dereferencing.

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

Dereferences the value.

impl<'de> Deserialize<'de> for OptionalPayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Option<Payload>> for OptionalPayload

fn from(option: Option<Payload>) -> Self

Converts to this type from the input type.

impl Into<Option<Payload>> for OptionalPayload

fn into(self) -> Option<Payload>

Converts this type into the (usually inferred) input type.

impl Packable for OptionalPayload

type UnpackError = Error

The error type that can be returned if some semantic error occurs while unpacking.

type UnpackVisitor = ProtocolParameters

FIXME: docs

fn pack<P: Packer>(&self, packer: &mut P) -> Result<(), P::Error>

Packs this value into the given Packer.

fn unpack<U: Unpacker, const VERIFY: bool>(
    unpacker: &mut U,
    visitor: &Self::UnpackVisitor
) -> Result<Self, UnpackError<Self::UnpackError, U::Error>>

Unpacks this value from the given Unpacker. The VERIFY generic parameter can be used to skip additional syntactic checks.

impl PartialEq<OptionalPayload> for OptionalPayload

fn eq(&self, other: &OptionalPayload) -> 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 Serialize for OptionalPayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for OptionalPayload

impl StructuralEq for OptionalPayload

impl StructuralPartialEq for OptionalPayload