Struct TpmCommand 

pub struct TpmCommand(/* private fields */);

A zero-copy TPM command wire view over caller-owned bytes.

Implementations

impl TpmCommand

pub fn cast(buf: &[u8]) -> TpmResult<&Self>

Casts a byte slice into a TPM command wire view.

Errors

Returns Err(TpmError) when the command envelope is malformed.

pub fn cast_prefix(buf: &[u8]) -> TpmResult<(&Self, &[u8])>

Casts the first TPM command frame in a byte slice into a wire view.

Errors

Returns Err(TpmError) when the command envelope is malformed or incomplete.

pub fn cast_mut(buf: &mut [u8]) -> TpmResult<&mut Self>

Casts a mutable byte slice into a mutable TPM command wire view.

Errors

Returns Err(TpmError) when the command envelope is malformed.

pub fn cast_prefix_mut(buf: &mut [u8]) -> TpmResult<(&mut Self, &mut [u8])>

Casts the first mutable TPM command frame in a byte slice into a wire view.

Errors

Returns Err(TpmError) when the command envelope is malformed or incomplete.

pub const fn as_bytes(&self) -> &[u8]

Returns the complete command frame bytes.

pub fn as_bytes_mut(&mut self) -> &mut [u8]

Returns the mutable command frame bytes.

pub fn tag(&self) -> TpmResult<TpmSt>

Returns the command tag.

Errors

Returns VariantNotAvailable when the tag value is not defined.

pub fn size(&self) -> u32

Returns the command frame size field.

pub fn cc(&self) -> TpmResult<TpmCc>

Returns the command code.

Errors

Returns InvalidCc when the command code has no dispatch entry.

pub fn set_tag(&mut self, tag: TpmSt)

Sets the command tag without changing the frame shape.

pub fn set_cc(&mut self, cc: TpmCc) -> TpmResult<()>

Sets the command code without changing the frame shape.

Errors

Returns InvalidCc when the command code has no dispatch entry.

pub fn handles(&self) -> TpmResult<&[u8]>

Returns the command handle area bytes.

Errors

Returns Err(TpmError) when the command envelope is malformed.

pub fn handles_mut(&mut self) -> TpmResult<&mut [u8]>

Returns the mutable command handle area bytes.

Errors

Returns Err(TpmError) when the command envelope is malformed.

pub fn auth_area(&self) -> TpmResult<&[u8]>

Returns the command authorization area bytes.

Errors

Returns Err(TpmError) when the command has no sessions or its authorization area is malformed.

pub fn auth_area_mut(&mut self) -> TpmResult<&mut [u8]>

Returns the mutable command authorization area bytes.

Errors

Returns Err(TpmError) when the command has no sessions or its authorization area is malformed.

pub fn parameters(&self) -> TpmResult<&[u8]>

Returns the command parameter area bytes.

Errors

Returns Err(TpmError) when the command envelope is malformed.

pub fn parameters_mut(&mut self) -> TpmResult<&mut [u8]>

Returns the mutable command parameter area bytes.

Errors

Returns Err(TpmError) when the command envelope is malformed.

pub fn validate(&self) -> TpmResult<()>

Validates command frame structure without constructing an owned command body.

Errors

Returns Err(TpmError) when the command frame is malformed.

pub const fn is_empty(&self) -> bool

Returns true when the command frame contains no bytes.

pub const fn len(&self) -> usize

Returns the command frame length.

impl TpmCommand

pub unsafe fn cast_unchecked(buf: &[u8]) -> &Self

Casts a byte slice into this wire view without validation.

Safety

The caller must ensure buf satisfies every invariant required by the checked constructors for this view.

pub unsafe fn cast_mut_unchecked(buf: &mut [u8]) -> &mut Self

Casts a mutable byte slice into this wire view without validation.

Safety

The caller must ensure buf satisfies every invariant required by the checked constructors for this view. The returned reference inherits the exclusive access represented by buf.

Trait Implementations

impl AsMut<[u8]> for TpmCommand

fn as_mut(&mut self) -> &mut [u8]

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

impl AsRef<[u8]> for TpmCommand

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

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

impl TpmCast for TpmCommand

fn cast(buf: &[u8]) -> TpmResult<&Self>

Casts buf into Self after validating the wire-view invariants.

fn cast_prefix(buf: &[u8]) -> TpmResult<(&Self, &[u8])>

Casts the first wire value in buf into Self and returns the remainder.

unsafe fn cast_unchecked(buf: &[u8]) -> &Self

Casts buf into Self without validating the wire-view invariants.

impl TpmCastMut for TpmCommand

fn cast_mut(buf: &mut [u8]) -> TpmResult<&mut Self>

Casts buf into mutable Self after validating the wire-view invariants.

fn cast_prefix_mut(buf: &mut [u8]) -> TpmResult<(&mut Self, &mut [u8])>

Casts the first mutable wire value in buf into Self and returns the remainder.

unsafe fn cast_mut_unchecked(buf: &mut [u8]) -> &mut Self

Casts buf into mutable Self without validating the wire-view invariants.