Struct Flags

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

👎Deprecated since 0.3.0: Use [bool; 8] directly instead

Encodes a set of bit flags packed into a single byte

Examples

use encode::Encodable;
use encode::combinators::Flags;

let mut buf = Vec::new();
Flags::new([false,false,false,false,false,false,false, false]).encode(&mut buf).unwrap();
assert_eq!(&buf, &[0]);

use encode::Encodable;
use encode::combinators::Flags;

let mut buf = Vec::new();
Flags::new([true,false,false,true,false,false,false, false]).encode(&mut buf).unwrap();
assert_eq!(&buf, &[0b1001_0000]);

Implementations

impl Flags

pub const fn new(flags: [bool; 8]) -> Self

Creates a new Flags combinator.

pub const fn into_inner(self) -> [bool; 8]

Consumes the Flags combinator and returns the inner value.

Trait Implementations

impl AsRef<[bool; 8]> for Flags

fn as_ref(&self) -> &[bool; 8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flags

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

Formats the value using the given formatter.

impl Deref for Flags

type Target = [bool; 8]

The resulting type after dereferencing.

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

Dereferences the value.

impl<E: ByteEncoder> Encodable<E> for Flags

type Error = <E as BaseEncoder>::Error

The error type returned by the encode method.

fn encode(&self, encoder: &mut E) -> Result<(), Self::Error>

Encodes self into the given encoder.

impl From<Flags> for u8

fn from(value: Flags) -> Self

Converts to this type from the input type.

impl From<u8> for Flags

fn from(value: u8) -> Self

Converts to this type from the input type.

impl Ord for Flags

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

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

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

impl Eq for Flags

impl StructuralPartialEq for Flags