Struct bcder::int::Integer

pub struct Integer(_);

A BER encoded integer.

As integers are variable length in BER, this type is just a simple wrapper atop the underlying Bytes value containing the raw content. A value of this type is a signed integer. If a value is defined as an unsigned integer, i.e., as INTEGER (0..MAX), you should use the sibling type Unsigned instead.

In addition to these two generic types, the content decoders also provide methods to parse integers into native integer types such as i8. If the range of such a type is obviously enough, you might want to consider using these methods instead.

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.

Implementations

impl Integer

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

Takes a single signed integer from the beginning of an encoded value.

This requires the next value in cons to be a primitive value with a correctly encoded signed integer.

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

Constructs a signed integer from the content of a primitive value.

pub fn i8_from_primitive<S: Source>(
    prim: &mut Primitive<'_, S>
) -> Result<i8, S::Err>

Constructs an i8 from the content of a primitive value.

pub fn i16_from_primitive<S: Source>(
    prim: &mut Primitive<'_, S>
) -> Result<i16, S::Err>

Constructs an i16 from the content of a primitive value.

pub fn i32_from_primitive<S: Source>(
    prim: &mut Primitive<'_, S>
) -> Result<i32, S::Err>

Constructs an i32 from the content of a primitive value.

pub fn i64_from_primitive<S: Source>(
    prim: &mut Primitive<'_, S>
) -> Result<i64, S::Err>

Constructs an i64 from the content of a primitive value.

pub fn i128_from_primitive<S: Source>(
    prim: &mut Primitive<'_, S>
) -> Result<i128, S::Err>

Constructs an i128 from the content of a primitive value.

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.

pub fn is_positive(&self) -> bool

Returns whether the integer is positive.

Also returns false if the number is zero.

pub fn is_negative(&self) -> bool

Returns whether the integer is negative.

Also returns false if the number is zero.

Trait Implementations

impl AsRef<[u8]> for Integer

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

Performs the conversion.

impl AsRef<Bytes> for Integer

pub fn as_ref(&self) -> &Bytes

Performs the conversion.

impl AsRef<Integer> for Unsigned

pub fn as_ref(&self) -> &Integer

Performs the conversion.

impl Clone for Integer

pub fn clone(&self) -> Integer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Integer

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

Formats the value using the given formatter.

impl Eq for Integer

impl From<i128> for Integer

pub fn from(val: i128) -> Integer

Performs the conversion.

impl From<i16> for Integer

pub fn from(val: i16) -> Integer

Performs the conversion.

impl From<i32> for Integer

pub fn from(val: i32) -> Integer

Performs the conversion.

impl From<i64> for Integer

pub fn from(val: i64) -> Integer

Performs the conversion.

impl From<i8> for Integer

pub fn from(val: i8) -> Integer

Performs the conversion.

impl From<u128> for Integer

pub fn from(val: u128) -> Integer

Performs the conversion.

impl From<u16> for Integer

pub fn from(val: u16) -> Integer

Performs the conversion.

impl From<u32> for Integer

pub fn from(val: u32) -> Integer

Performs the conversion.

impl From<u64> for Integer

pub fn from(val: u64) -> Integer

Performs the conversion.

impl From<u8> for Integer

pub fn from(val: u8) -> Integer

Performs the conversion.

impl Hash for Integer

pub fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Integer

pub fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Integer> for Integer

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<Unsigned> for Integer

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Integer> for Integer

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Integer

pub const TAG: Tag

The natural tag of an encoded value of this type.

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

Returns the length of the encoded content of this type.

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

Writes the encoded content to a writer.

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

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

pub fn encode(self) -> Primitive<Self>

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

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

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

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

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

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

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

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for i8

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for i16

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for i32

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for i64

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for i128

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for u8

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for u16

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for u32

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for u64

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Integer> for u128

type Error = OverflowError

The type returned in the event of a conversion error.

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

Performs the conversion.