Struct untrusted::input::Input

pub struct Input<'a> {
    value: Slice<'a>,
}

A wrapper around &'a [u8] that helps in writing panic-free code.

No methods of Input will ever panic.

Intentionally avoids implementing PartialEq and Eq to avoid implicit non-constant-time comparisons.

Fields

value: Slice<'a>

Implementations

impl<'a> Input<'a>

pub const fn from(bytes: &'a [u8]) -> Self

Construct a new Input for the given input bytes.

pub fn is_empty(&self) -> bool

Returns true if the input is empty and false otherwise.

pub fn len(&self) -> usize

Returns the length of the Input.

pub fn read_all<F, R, E>(&self, incomplete_read: E, read: F) -> Result<R, E>

where F: FnOnce(&mut Reader<'a>) -> Result<R, E>,

Calls read with the given input as a Reader, ensuring that read consumed the entire input. If read does not consume the entire input, incomplete_read is returned.

pub fn as_slice_less_safe(&self) -> &'a [u8]

Access the input as a slice so it can be processed by functions that are not written using the Input/Reader framework.

pub(crate) fn into_value(self) -> Slice<'a>

Trait Implementations

impl<'a> Clone for Input<'a>

fn clone(&self) -> Input<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Input<'_>

The value is intentionally omitted from the output to avoid leaking secrets.

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

Formats the value using the given formatter.

impl<'a> From<&'a [u8]> for Input<'a>

fn from(value: &'a [u8]) -> Self

Converts to this type from the input type.

impl<'a> From<Slice<'a>> for Input<'a>

fn from(value: Slice<'a>) -> Self

Converts to this type from the input type.

impl<'a> Copy for Input<'a>