Struct Integer

pub struct Integer<'a> { /* private fields */ }

ASN.1 INTEGER type

Generic representation for integer types. BER/DER integers can be of any size, so it is not possible to store them as simple integers (they are stored as raw bytes).

The internal representation can be obtained using .as_ref().

Note

Methods from/to BER and DER encodings are also implemented for primitive types (u8, u16 to u128, and i8 to i128). In most cases, it is easier to use these types directly.

Examples

Creating an Integer

use asn1_rs::Integer;

// unsigned
let i = Integer::from(4);
assert_eq!(i.as_ref(), &[4]);
// signed
let j = Integer::from(-2);
assert_eq!(j.as_ref(), &[0xfe]);

Converting an Integer to a primitive type (using the TryInto trait)

use asn1_rs::{Error, Integer};
use std::convert::TryInto;

let i = Integer::new(&[0x12, 0x34, 0x56, 0x78]);
// converts to an u32
let n: u32 = i.try_into().unwrap();

// Same, but converting to an u16: will fail, value cannot fit into an u16
let i = Integer::new(&[0x12, 0x34, 0x56, 0x78]);
assert_eq!(i.try_into() as Result<u16, _>, Err(Error::IntegerTooLarge));

Encoding an Integer to DER

use asn1_rs::{Integer, ToDer};

let i = Integer::from(4);
let v = i.to_der_vec().unwrap();
assert_eq!(&v, &[2, 1, 4]);

// same, with primitive types
let v = 4.to_der_vec().unwrap();
assert_eq!(&v, &[2, 1, 4]);

Implementations

impl<'a> Integer<'a>

pub const fn new(s: &'a [u8]) -> Self

Creates a new Integer containing the given value (borrowed).

pub fn any(&'a self) -> Any<'a>

Creates a borrowed Any for this object

pub fn as_raw_slice(&self) -> Option<&'a [u8]>

Return a reference to the raw data, if shared

Note: unlike .as_ref(), this function can return a reference that can outlive the current object (if the raw data does).

pub fn as_bigint(&self) -> BigInt

Available on crate feature bigint only.

Returns a BigInt built from this Integer value.

pub fn as_biguint(&self) -> Result<BigUint>

Available on crate feature bigint only.

Returns a BigUint built from this Integer value.

pub fn from_const_array<const N: usize>(b: [u8; N]) -> Self

Build an Integer from a constant array of bytes representation of an integer.

impl Integer<'_>

pub fn as_i8(&self) -> Result<i8>

Attempts to convert an Integer to a i8.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_i8(i: i8) -> Self

Converts a i8 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_i16(&self) -> Result<i16>

Attempts to convert an Integer to a i16.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_i16(i: i16) -> Self

Converts a i16 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_i32(&self) -> Result<i32>

Attempts to convert an Integer to a i32.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_i32(i: i32) -> Self

Converts a i32 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_i64(&self) -> Result<i64>

Attempts to convert an Integer to a i64.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_i64(i: i64) -> Self

Converts a i64 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_i128(&self) -> Result<i128>

Attempts to convert an Integer to a i128.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_i128(i: i128) -> Self

Converts a i128 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_isize(&self) -> Result<isize>

Attempts to convert an Integer to a isize.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_isize(i: isize) -> Self

Converts a isize to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_u8(&self) -> Result<u8>

Attempts to convert an Integer to a u8.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_u8(i: u8) -> Self

Converts a u8 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_u16(&self) -> Result<u16>

Attempts to convert an Integer to a u16.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_u16(i: u16) -> Self

Converts a u16 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_u32(&self) -> Result<u32>

Attempts to convert an Integer to a u32.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_u32(i: u32) -> Self

Converts a u32 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_u64(&self) -> Result<u64>

Attempts to convert an Integer to a u64.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_u64(i: u64) -> Self

Converts a u64 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_u128(&self) -> Result<u128>

Attempts to convert an Integer to a u128.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_u128(i: u128) -> Self

Converts a u128 to an Integer

Note: this function allocates data.

impl Integer<'_>

pub fn as_usize(&self) -> Result<usize>

Attempts to convert an Integer to a usize.

This function returns an IntegerTooLarge error if the integer will not fit into the output type.

impl Integer<'_>

pub fn from_usize(i: usize) -> Self

Converts a usize to an Integer

Note: this function allocates data.

Trait Implementations

impl AsRef<[u8]> for Integer<'_>

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

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

impl<'i> BerParser<'i> for Integer<'i>

type Error = BerError<Input<'i>>

The Error type for parsing errors.

fn from_ber_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new BER object from header and data.

fn parse_ber(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new BER object from data.

fn parse_ber_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_ber_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl CheckDerConstraints for Integer<'_>

fn check_constraints(any: &Any<'_>) -> Result<()>

impl<'a> Clone for Integer<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Integer<'a>

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

Formats the value using the given formatter.

impl<'i> DerParser<'i> for Integer<'i>

type Error = BerError<Input<'i>>

The Error type for parsing errors.

fn from_der_content( header: &Header<'i>, input: Input<'i>, ) -> IResult<Input<'i>, Self, Self::Error>

Parse a new DER object from header and data.

fn parse_der(input: Input<'i>) -> IResult<Input<'i>, Self, Self::Error>

Attempt to parse a new DER object from data.

fn parse_der_optional( input: Input<'i>, ) -> IResult<Input<'i>, Option<Self>, Self::Error>

fn parse_der_as_input( input: Input<'i>, ) -> IResult<Input<'i>, (Header<'i>, Input<'i>), Self::Error>

Parse object header (validating tag) and return header and content as Input

impl From<i128> for Integer<'_>

fn from(i: i128) -> Self

Converts to this type from the input type.

impl From<i16> for Integer<'_>

fn from(i: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Integer<'_>

fn from(i: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Integer<'_>

fn from(i: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Integer<'_>

fn from(i: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Integer<'_>

fn from(i: isize) -> Self

Converts to this type from the input type.

impl From<u128> for Integer<'_>

fn from(i: u128) -> Self

Converts to this type from the input type.

impl From<u16> for Integer<'_>

fn from(i: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Integer<'_>

fn from(i: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Integer<'_>

fn from(i: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Integer<'_>

fn from(i: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Integer<'_>

fn from(i: usize) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Integer<'a>

fn eq(&self, other: &Integer<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Tagged for Integer<'_>

const TAG: Tag = Tag::Integer

const CLASS: Class = Class::Universal

const CONSTRUCTED: bool = false

impl ToBer for Integer<'_>

type Encoder = Primitive<{ Tag::Integer.0 }>

fn ber_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn ber_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn ber_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn ber_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn ber_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn ber_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn ber_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn ber_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

fn to_ber_vec(&self) -> SerializeResult<Vec<u8>>

Write the DER encoded representation to a newly allocated Vec<u8>

fn write_ber<W: Write>(&self, writer: &mut W) -> SerializeResult<usize>

Encode in BER and write the object (header + content) to the writer target

impl<'a> ToDer for Integer<'a>

where Integer<'a>: ToBer,

type Encoder = <Integer<'a> as ToBer>::Encoder

fn der_content_len(&self) -> Length

Returns the length of the encoded content of the object

fn der_tag_info(&self) -> (Class, bool, Tag)

Return the tag information to be encoded in header

fn der_write_content<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the content of the object to the writer target

fn der_total_len(&self) -> Length

Returns the total length (including header) of the encoded content of the object

fn der_write_header<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the header of the object to the writer target

fn der_encode<W: Write>(&self, target: &mut W) -> SerializeResult<usize>

Encode and write the object (header + content) to the writer target

fn der_encode_tagged_explicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED EXPLICIT and write it to the writer target

fn der_encode_tagged_implicit<W: Write>( &self, class: Class, tag_number: u32, target: &mut W, ) -> SerializeResult<usize>

Encode and write the object (header + content) as TAGGED IMPLICIT and write it to the writer target

fn to_der_vec(&self) -> SerializeResult<Vec<u8>>

Write the DER encoded representation to a newly allocated Vec<u8>

fn write_der<W: Write>(&self, writer: &mut W) -> SerializeResult<usize>

Encode in DER and write the object (header + content) to the writer target

fn to_der_len(&self) -> Result<usize>

👎Deprecated since 0.8.0: Use der_total_len() instead.

Get the length of the object (including the header), when encoded

fn to_der_vec_raw(&self) -> SerializeResult<Vec<u8>>

👎Deprecated since 0.8.0: Use to_der_vec() instead.

impl<'i, 'b> TryFrom<&'b Any<'i>> for Integer<'i>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: &'b Any<'i>) -> Result<Self>

Performs the conversion.

impl<'i> TryFrom<Any<'i>> for Integer<'i>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: Any<'i>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for i128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for i16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for i32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for i64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for i8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for isize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for u128

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for u16

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for u32

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for u64

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for u8

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<Integer<'_>> for usize

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Integer<'_>) -> Result<Self>

Performs the conversion.

impl DerAutoDerive for Integer<'_>

impl<'a> Eq for Integer<'a>

impl<'a> StructuralPartialEq for Integer<'a>