Struct Boolean

pub struct Boolean(/* private fields */);

The boolean representation of AMF data types. This uses 1 byte integer as a boolean value. Usually, 0 is treated as false, else is true.

Examples

use sheave_core::messages::amf::v0::Boolean;

assert_eq!(false, Boolean::new(0));
assert_eq!(true, Boolean::new(1));
assert_eq!(true, Boolean::new(u8::MAX))

Implementations

impl Boolean

pub fn new(boolean: u8) -> Self

Constructs an AMF’s Boolean.

pub fn as_boolean(&self) -> bool

Gets an inner value as a boolean value.

Trait Implementations

impl Clone for Boolean

fn clone(&self) -> Boolean

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Boolean

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

Formats the value using the given formatter.

impl Decoder<Boolean> for ByteBuffer

fn decode(&mut self) -> IOResult<Boolean>

Decodes bytes into an AMF’s Boolean.

Errors

• InsufficientBufferLength

When buffer isn’t remained at least 2 bytes.

• InconsistentMarker

When a marker byte doesn’t indicate the AMF Boolean.

Examples

use sheave_core::{
    ByteBuffer,
    Decoder,
    messages::amf::v0::{
        Marker,
        Boolean
    }
};

let mut buffer = ByteBuffer::default();
buffer.put_u8(Marker::Boolean as u8);
buffer.put_u8(0);
assert!(Decoder::<Boolean>::decode(&mut buffer).is_ok());

let mut buffer = ByteBuffer::default();
buffer.put_u8(Marker::Number as u8);
buffer.put_u8(0);
assert!(Decoder::<Boolean>::decode(&mut buffer).is_err());

let mut buffer = ByteBuffer::default();
assert!(Decoder::<Boolean>::decode(&mut buffer).is_err())

impl Default for Boolean

fn default() -> Boolean

Returns the “default value” for a type.

impl Display for Boolean

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

Formats the value using the given formatter.

impl Encoder<Boolean> for ByteBuffer

fn encode(&mut self, boolean: &Boolean)

Encodes an AMF’s Boolean into bytes.

impl Hash for Boolean

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 Ord for Boolean

fn cmp(&self, other: &Boolean) -> 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.

impl PartialEq<Boolean> for bool

fn eq(&self, other: &Boolean) -> 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 PartialEq<bool> for Boolean

fn eq(&self, other: &bool) -> 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 PartialEq for Boolean

fn eq(&self, other: &Boolean) -> 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 PartialOrd<Boolean> for bool

fn partial_cmp(&self, other: &Boolean) -> 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 PartialOrd<bool> for Boolean

fn partial_cmp(&self, other: &bool) -> 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 PartialOrd for Boolean

fn partial_cmp(&self, other: &Boolean) -> 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 Copy for Boolean

impl Eq for Boolean

impl StructuralPartialEq for Boolean