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.

Methods

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<'a> PrimitiveContent for &'a Integer

const TAG: Tag

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 From<i8> for Integer

fn from(val: i8) -> Integer

Performs the conversion.

impl From<i16> for Integer

fn from(val: i16) -> Integer

Performs the conversion.

impl From<i32> for Integer

fn from(val: i32) -> Integer

Performs the conversion.

impl From<i64> for Integer

fn from(val: i64) -> Integer

Performs the conversion.

impl From<i128> for Integer

fn from(val: i128) -> Integer

Performs the conversion.

impl From<u8> for Integer

fn from(val: u8) -> Integer

Performs the conversion.

impl From<u16> for Integer

fn from(val: u16) -> Integer

Performs the conversion.

impl From<u32> for Integer

fn from(val: u32) -> Integer

Performs the conversion.

impl From<u64> for Integer

fn from(val: u64) -> Integer

Performs the conversion.

impl From<u128> for Integer

fn from(val: u128) -> Integer

Performs the conversion.

impl Clone for Integer

fn clone(&self) -> Integer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Integer> for Integer

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

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

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

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

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 AsRef<Bytes> for Integer

fn as_ref(&self) -> &Bytes

Performs the conversion.

impl AsRef<[u8]> for Integer

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

Performs the conversion.

impl AsRef<Integer> for Unsigned

fn as_ref(&self) -> &Integer

Performs the conversion.

impl Eq for Integer

impl Ord for Integer

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Integer> for Integer

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

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

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

This method tests for !=.

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 ==.

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

This method tests for !=.

impl Debug for Integer

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

Formats the value using the given formatter.

impl Hash for Integer

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].