Skip to main content

TpmError

Enum TpmError 

Source
pub enum TpmError {
    BufferOverflow {
        offset: usize,
        needed: usize,
        available: usize,
    },
    IntegerTooLarge {
        offset: usize,
        value: u64,
    },
    InvalidBoolean {
        offset: usize,
        value: u64,
    },
    InvalidCc {
        offset: usize,
        value: u64,
    },
    InvalidMagicNumber {
        offset: usize,
        value: u64,
    },
    InvalidRc {
        offset: usize,
        value: u64,
    },
    InvalidTag {
        offset: usize,
        value: u64,
    },
    TooManyBytes {
        offset: usize,
        limit: usize,
        actual: usize,
    },
    TooManyItems {
        offset: usize,
        limit: usize,
        actual: usize,
    },
    TrailingData {
        offset: usize,
        actual: usize,
    },
    UnexpectedEnd {
        offset: usize,
        needed: usize,
        available: usize,
    },
    VariantNotAvailable {
        offset: usize,
        value: u64,
    },
}
Expand description

TPM frame marshaling and unmarshaling error type.

Every variant carries the byte offset from the start of the parsed buffer along with the diagnostic counts relevant to that failure.

Variants§

§

BufferOverflow

Trying to marshal more bytes than buffer has space. This is unexpected situation, and should be considered possible bug in the crate itself.

Fields

§offset: usize

Byte offset from the start of the buffer.

§needed: usize

Required byte count.

§available: usize

Available byte count.

§

IntegerTooLarge

Integer overflow while converting to an integer of a different size.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw value that did not fit.

§

InvalidBoolean

Boolean value was expected but the value is neither 0 nor 1.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw value encountered.

§

InvalidCc

Non-existent command code encountered.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw command code encountered.

§

InvalidMagicNumber

A TpmsAttest instance does not begin with the TPM_GENERATED_VALUE magic.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw magic value encountered.

§

InvalidRc

Invalid TPM response code encountered.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw response code encountered.

§

InvalidTag

Tag is neither Sessions nor NoSessions.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw tag encountered.

§

TooManyBytes

Buffer contains more bytes than allowed by the TCG specifications.

Fields

§offset: usize

Byte offset from the start of the buffer.

§limit: usize

Maximum allowed byte count.

§actual: usize

Actual byte count.

§

TooManyItems

List contains more items than allowed by the TCG specifications.

Fields

§offset: usize

Byte offset from the start of the buffer.

§limit: usize

Maximum allowed item count.

§actual: usize

Actual item count.

§

TrailingData

Trailing data left after unmarshaling.

Fields

§offset: usize

Byte offset from the start of the buffer.

§actual: usize

Trailing byte or item count.

§

UnexpectedEnd

Run out of bytes while unmarshaling.

Fields

§offset: usize

Byte offset from the start of the buffer.

§needed: usize

Required byte count.

§available: usize

Available byte count.

§

VariantNotAvailable

The variant accessed is not available.

Fields

§offset: usize

Byte offset from the start of the buffer.

§value: u64

Raw value encountered.

Implementations§

Source§

impl TpmError

Source

pub const fn kind(self) -> &'static str

Returns the stable machine-readable name of the error variant.

Trait Implementations§

Source§

impl Clone for TpmError

Source§

fn clone(&self) -> TpmError

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for TpmError

Source§

impl Debug for TpmError

Source§

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

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

impl Display for TpmError

Renders TpmError as its bare variant name in lowercase, space-separated words (e.g. BufferOverflow becomes buffer overflow).

As the lowest-level crate in the stack, errors expose only the variant name here, derived from the stable kind discriminant. Callers read the structured fields directly and decide how to present the diagnostic detail.

Source§

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

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

impl Eq for TpmError

Source§

impl Error for TpmError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl PartialEq for TpmError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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 StructuralPartialEq for TpmError

Auto Trait Implementations§

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