Struct Restrict

pub struct Restrict<T>(/* private fields */);

Untrusted types will be wrapped in this type.

To gain access to the data, some form of verification through one of the public methods is necessary.

Implementations

impl<T> Restrict<T>

pub fn new(restricted: T) -> Restrict<T>

Create a new restricted type

pub fn verify<'a, F>(&'a self, f: F) -> Verified<'a, T>

where F: Fn(&'a T) -> bool,

It is the responsibility of this function to verify the contained type is valid.

use hickory_proto::serialize::binary::Restrict;

let unrestricted = Restrict::new(0).verify(|r| *r == 0).then(|r| *r + 1).unwrap();
assert!(unrestricted == 1);

Returns

If f returns true then the value is valid and a chainable Verified type is returned

pub fn verify_unwrap<F>(self, f: F) -> Result<T, T>

where F: Fn(&T) -> bool,

It is the responsibility of this function to verify the contained type is valid.

use hickory_proto::serialize::binary::Restrict;

let unrestricted = Restrict::new(0).verify_unwrap(|r| *r == 0).unwrap();
assert!(unrestricted == 0);

Returns

If f returns true then the value is valid and Ok(T) is returned. Otherwise Err(T) is returned.

pub fn unverified(self) -> T

Unwraps the value without verifying the data, akin to Result::unwrap and Option::unwrap, but will not panic

pub fn map<R, F>(self, f: F) -> Restrict<R>

where F: Fn(T) -> R,

Map the internal type of the restriction

use hickory_proto::serialize::binary::Restrict;

let restricted = Restrict::new(0).map(|b| vec![b, 1]);
assert!(restricted.verify(|v| v == &[0, 1]).is_valid());
assert!(!restricted.verify(|v| v == &[1, 0]).is_valid());

Trait Implementations

impl<T> Clone for Restrict<T>

where T: Clone,

fn clone(&self) -> Restrict<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl RestrictedMath for Restrict<u16>

type Arg = u16

Argument for the math operations

type Value = u16

Return value, generally the same as Arg

fn checked_add( &self, arg: <Restrict<u16> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<u16> as RestrictedMath>::Value>, <Restrict<u16> as RestrictedMath>::Arg>

Checked addition, see usize::checked_add

fn checked_sub( &self, arg: <Restrict<u16> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<u16> as RestrictedMath>::Value>, <Restrict<u16> as RestrictedMath>::Arg>

Checked subtraction, see usize::checked_sub

fn checked_mul( &self, arg: <Restrict<u16> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<u16> as RestrictedMath>::Value>, <Restrict<u16> as RestrictedMath>::Arg>

Checked multiplication, see usize::checked_mul

impl RestrictedMath for Restrict<u8>

type Arg = u8

Argument for the math operations

type Value = u8

Return value, generally the same as Arg

fn checked_add( &self, arg: <Restrict<u8> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<u8> as RestrictedMath>::Value>, <Restrict<u8> as RestrictedMath>::Arg>

Checked addition, see usize::checked_add

fn checked_sub( &self, arg: <Restrict<u8> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<u8> as RestrictedMath>::Value>, <Restrict<u8> as RestrictedMath>::Arg>

Checked subtraction, see usize::checked_sub

fn checked_mul( &self, arg: <Restrict<u8> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<u8> as RestrictedMath>::Value>, <Restrict<u8> as RestrictedMath>::Arg>

Checked multiplication, see usize::checked_mul

impl RestrictedMath for Restrict<usize>

type Arg = usize

Argument for the math operations

type Value = usize

Return value, generally the same as Arg

fn checked_add( &self, arg: <Restrict<usize> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<usize> as RestrictedMath>::Value>, <Restrict<usize> as RestrictedMath>::Arg>

Checked addition, see usize::checked_add

fn checked_sub( &self, arg: <Restrict<usize> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<usize> as RestrictedMath>::Value>, <Restrict<usize> as RestrictedMath>::Arg>

Checked subtraction, see usize::checked_sub

fn checked_mul( &self, arg: <Restrict<usize> as RestrictedMath>::Arg, ) -> Result<Restrict<<Restrict<usize> as RestrictedMath>::Value>, <Restrict<usize> as RestrictedMath>::Arg>

Checked multiplication, see usize::checked_mul

impl<T> Copy for Restrict<T>

where T: Copy,