Struct MPI

Source
pub struct MPI { /* private fields */ }
Expand description

A Multiprecision Integer.

Implementations§

Source§

impl MPI

Source

pub fn new(value: &[u8]) -> Self

Creates a new MPI.

This function takes care of removing leading zeros.

Source

pub fn new_point(x: &[u8], y: &[u8], field_bits: usize) -> Self

Creates new MPI encoding an uncompressed EC point.

Encodes the given point on an elliptic curve (see Section 6 of RFC 6637 for details). This is used to encode public keys and ciphertexts for the NIST curves (NistP256, NistP384, and NistP521).

Source

pub fn new_compressed_point(x: &[u8]) -> Self

Creates new MPI encoding a compressed EC point using native encoding.

Encodes the given point on an elliptic curve (see Section 13.2 of RFC4880bis for details). This is used to encode public keys and ciphertexts for the Bernstein curves (currently X25519).

Source

pub fn zero() -> Self

Creates a new MPI representing zero.

Source

pub fn is_zero(&self) -> bool

Tests whether the MPI represents zero.

Source

pub fn bits(&self) -> usize

Returns the length of the MPI in bits.

Leading zero-bits are not included in the returned size.

Source

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

Returns the value of this MPI.

Note that due to stripping of zero-bytes, the returned value may be shorter than expected.

Source

pub fn value_padded(&self, to: usize) -> Result<Cow<'_, [u8]>>

Returns the value of this MPI zero-padded to the given length.

MPI-encoding strips leading zero-bytes. This function adds them back, if necessary. If the size exceeds to, an error is returned.

Source

pub fn decode_point(&self, curve: &Curve) -> Result<(&[u8], &[u8])>

Decodes an EC point encoded as MPI.

Decodes the MPI into a point on an elliptic curve (see Section 6 of RFC 6637 and Section 13.2 of RFC4880bis for details). If the point is not compressed, the function returns (x, y). If it is compressed, y will be empty.

§Errors

Returns Error::UnsupportedEllipticCurve if the curve is not supported, Error::MalformedMPI if the point is formatted incorrectly, Error::InvalidOperation if the given curve is operating on native octet strings.

Trait Implementations§

Source§

impl Clone for MPI

Source§

fn clone(&self) -> MPI

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MPI

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Box<[u8]>> for MPI

Source§

fn from(v: Box<[u8]>) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<u8>> for MPI

Source§

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.
Source§

impl Hash for MPI

Source§

fn hash(&self, hash: &mut Context) -> Result<()>

Updates the given hash with this object.
Source§

impl Hash for MPI

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Marshal for MPI

Source§

fn serialize(&self, w: &mut dyn Write) -> Result<()>

Writes a serialized version of the object to o.
Source§

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o. Read more
Source§

impl MarshalInto for MPI

Source§

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation. Read more
Source§

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer. Read more
Source§

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.
Source§

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer. Read more
Source§

fn export_to_vec(&self) -> Result<Vec<u8>>

Exports to a vector. Read more
Source§

impl Ord for MPI

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl<'a> Parse<'a, MPI> for MPI

Source§

fn from_buffered_reader<R>(reader: R) -> Result<Self>
where R: BufferedReader<Cookie> + 'a,

Reads from the given buffered reader. Read more
Source§

fn from_reader<R: 'a + Read + Send + Sync>(reader: R) -> Result<T>

Reads from the given reader. Read more
Source§

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file. Read more
Source§

fn from_bytes<D: AsRef<[u8]> + ?Sized + Send + Sync>(data: &'a D) -> Result<T>

Reads from the given slice. Read more
Source§

impl PartialEq for MPI

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for MPI

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Eq for MPI

Auto Trait Implementations§

§

impl Freeze for MPI

§

impl RefUnwindSafe for MPI

§

impl Send for MPI

§

impl Sync for MPI

§

impl Unpin for MPI

§

impl UnwindSafe for MPI

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> ErasedDestructor for T
where T: 'static,