Struct Header

pub struct Header {
    pub list: bool,
    pub payload_length: usize,
}

Available on crate feature rlp only.

The header of an RLP item.

Fields

list: bool

True if list, false otherwise.

payload_length: usize

Length of the payload in bytes.

Implementations

impl Header

pub fn decode(buf: &mut &[u8]) -> Result<Header, Error>

Decodes an RLP header from the given buffer.

Errors

Returns an error if the buffer is too short or the header is invalid.

pub fn decode_bytes<'a>( buf: &mut &'a [u8], is_list: bool, ) -> Result<&'a [u8], Error>

Decodes the next payload from the given buffer, advancing it.

Errors

Returns an error if the buffer is too short or the header is invalid.

pub fn decode_str<'a>(buf: &mut &'a [u8]) -> Result<&'a str, Error>

Decodes a string slice from the given buffer, advancing it.

Errors

Returns an error if the buffer is too short or the header is invalid.

pub fn decode_raw<'a>(buf: &mut &'a [u8]) -> Result<PayloadView<'a>, Error>

Extracts the next payload from the given buffer, advancing it.

The returned PayloadView provides a structured view of the payload, allowing for efficient parsing of nested items without unnecessary allocations.

Errors

Returns an error if:

• The buffer is too short
• The header is invalid
• Any nested headers (for list items) are invalid

pub fn encode(&self, out: &mut dyn BufMut)

Encodes the header into the out buffer.

pub const fn length(&self) -> usize

Returns the length of the encoded header.

pub const fn length_with_payload(&self) -> usize

Returns the total length of the encoded header and payload.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Default for Header

fn default() -> Header

Returns the “default value” for a type.

impl PartialEq for Header

fn eq(&self, other: &Header) -> 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 Eq for Header

impl StructuralPartialEq for Header

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes