Struct SizeHint

#[non_exhaustive]
pub struct SizeHint { /* private fields */ }

A length hint.

Implementations

impl SizeHint

pub const fn any() -> Self

Construct a size hint of unknown size.

Examples

use musli::de::SizeHint;

let hint = SizeHint::any();
assert_eq!(hint.or_default(), 0);

pub const fn exact(length: usize) -> Self

Construct an exactly sized hint.

Examples

use musli::de::SizeHint;

let hint = SizeHint::exact(16);
assert_eq!(hint.or_default(), 16);

pub fn or_default(self) -> usize

Get a size hint or a default value.

Examples

use musli::de::SizeHint;

let hint = SizeHint::any();
assert_eq!(hint.or_default(), 0);

impl SizeHint

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

Coerce into an Option.

Trait Implementations

impl Clone for SizeHint

fn clone(&self) -> SizeHint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SizeHint

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

Formats the value using the given formatter.

impl Default for SizeHint

fn default() -> SizeHint

Returns the “default value” for a type.

impl Display for SizeHint

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

Formats the value using the given formatter.

impl From<Option<usize>> for SizeHint

fn from(value: Option<usize>) -> Self

Converts to this type from the input type.

impl Copy for SizeHint