Struct bcder::int::Unsigned

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

A BER encoded unsigned integer.

As integers are variable length in BER, this type is just a simple wrapper atop the underlying Bytes value containing the raw content. It guarantees that the wrapped integer is greater or equal to 0. This equals an integer defined as INTEGER (0..MAX) in ASN.1.

If you need a integer without any restrictions, you can use Integer. If you have even stricter range restrictions, you can also use the methods provided on the content types to decode into Rust’s primitive integer types such as u16.

BER Encoding

In BER, an INTEGER is encoded as a primitive value with the content octets providing a variable-length, big-endian, two‘s complement byte sequence of that integer. Thus, the most-significant bit of the first octet serves as the sign bit and, for an unsigned integer, has to be unset.

Implementations

impl Unsigned

Decoding and Encoding

pub fn from_slice(slice: &[u8]) -> Result<Self, InvalidInteger>

Constructs Unsigned by copying from a &[u8].

Errors

Will return a malformed error if the given slice is empty.

pub fn from_bytes(bytes: Bytes) -> Result<Self, InvalidInteger>

Constructs Unsigned from Bytes, copying only if needed.

Errors

Will return a malformed error if the given slice is empty.

pub fn take_from<S: Source>( cons: &mut Constructed<'_, S> ) -> Result<Self, DecodeError<S::Error>>

pub fn from_primitive<S: Source>( prim: &mut Primitive<'_, S> ) -> Result<Self, DecodeError<S::Error>>

pub fn u8_from_primitive<S: Source>( prim: &mut Primitive<'_, S> ) -> Result<u8, DecodeError<S::Error>>

pub fn u16_from_primitive<S: Source>( prim: &mut Primitive<'_, S> ) -> Result<u16, DecodeError<S::Error>>

pub fn u32_from_primitive<S: Source>( prim: &mut Primitive<'_, S> ) -> Result<u32, DecodeError<S::Error>>

pub fn u64_from_primitive<S: Source>( prim: &mut Primitive<'_, S> ) -> Result<u64, DecodeError<S::Error>>

pub fn u128_from_primitive<S: Source>( prim: &mut Primitive<'_, S> ) -> Result<u128, DecodeError<S::Error>>

pub fn into_bytes(self) -> Bytes

Trades the integer into a bytes value with the raw content octets.

pub fn as_slice(&self) -> &[u8]

Returns a bytes slice with the raw content.

pub fn is_zero(&self) -> bool

Returns whether the number is zero.

Trait Implementations

impl AsRef<[u8]> for Unsigned

fn as_ref(&self) -> &[u8]

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

impl AsRef<Bytes> for Unsigned

fn as_ref(&self) -> &Bytes

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

impl AsRef<Integer> for Unsigned

fn as_ref(&self) -> &Integer

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

impl Clone for Unsigned

fn clone(&self) -> Unsigned

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unsigned

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

Formats the value using the given formatter.

impl From<u128> for Unsigned

fn from(val: u128) -> Unsigned

Converts to this type from the input type.

impl From<u16> for Unsigned

fn from(val: u16) -> Unsigned

Converts to this type from the input type.

impl From<u32> for Unsigned

fn from(val: u32) -> Unsigned

Converts to this type from the input type.

impl From<u64> for Unsigned

fn from(val: u64) -> Unsigned

Converts to this type from the input type.

impl From<u8> for Unsigned

fn from(val: u8) -> Unsigned

Converts to this type from the input type.

impl Hash for Unsigned

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 Unsigned

fn cmp(&self, other: &Unsigned) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<Unsigned> for Integer

fn eq(&self, other: &Unsigned) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for Unsigned

fn eq(&self, other: &Unsigned) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Unsigned

fn partial_cmp(&self, other: &Unsigned) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> PrimitiveContent for &'a Unsigned

const TAG: Tag = Tag::INTEGER

The natural tag of an encoded value of this type.

fn encoded_len(&self, mode: Mode) -> usize

Returns the length of the encoded content of this type.

fn write_encoded<W: Write>( &self, mode: Mode, target: &mut W ) -> Result<(), Error>

Writes the encoded content to a writer.

fn to_encoded_bytes(&self, mode: Mode) -> Bytes

Encodes the value to bytes (useful when you need to sign a structure)

fn encode(self) -> Primitive<Self>

Returns a value encoder for this content using the natural tag.

fn encode_as(self, tag: Tag) -> Primitive<Self>

Returns a value encoder for this content using the given tag.

fn encode_ref(&self) -> Primitive<&Self>

Returns a value encoder for a reference using the natural tag.

fn encode_ref_as(&self, tag: Tag) -> Primitive<&Self>

Returns a value encoder for a reference using the given tag.

impl<'a> TryFrom<&'a Unsigned> for i128

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<i128, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for i16

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<i16, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for i32

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<i32, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for i64

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<i64, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for i8

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<i8, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for u128

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<u128, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for u16

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<u16, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for u32

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<u32, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for u64

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<u64, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a Unsigned> for u8

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: &'a Unsigned) -> Result<u8, Self::Error>

Performs the conversion.

impl TryFrom<Bytes> for Unsigned

type Error = InvalidInteger

The type returned in the event of a conversion error.

fn try_from(value: Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for i128

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<i128, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for i16

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<i16, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for i32

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<i32, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for i64

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<i64, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for i8

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<i8, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for u128

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<u128, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for u16

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<u16, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for u32

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<u32, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for u64

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<u64, Self::Error>

Performs the conversion.

impl TryFrom<Unsigned> for u8

type Error = OverflowError

The type returned in the event of a conversion error.

fn try_from(val: Unsigned) -> Result<u8, Self::Error>

Performs the conversion.

impl Eq for Unsigned

impl StructuralEq for Unsigned

impl StructuralPartialEq for Unsigned