Struct ChunkTypeId 

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

Wire-level chunk type identifier.

This type represents the type ID byte used in chunk headers for serialization and deserialization dispatch. It provides type-safe constants for known chunk types and supports custom types.

Type ID Ranges

• 0-127: Reserved for standard Swarm chunk types
• 128-255: Available for custom/experimental chunk types

Examples

use nectar_primitives::ChunkTypeId;

// Use predefined constants
let content_type = ChunkTypeId::CONTENT;
let soc_type = ChunkTypeId::SINGLE_OWNER;

// Create custom type ID
let custom_type = ChunkTypeId::custom(200);

// Compare type IDs
assert_ne!(content_type, soc_type);
assert_eq!(content_type.as_u8(), 0);

Implementations

impl ChunkTypeId

pub const CONTENT: Self

Content-addressed chunk type (CAC).

These chunks have their address derived from the BMT hash of their content.

pub const SINGLE_OWNER: Self

Single-owner chunk type (SOC).

These chunks include owner identification and a digital signature.

pub const fn new(id: u8) -> Self

Create a new chunk type ID from a raw byte value.

This is a const fn allowing use in const contexts.

pub const fn custom(id: u8) -> Self

Create a custom chunk type ID.

Custom types should use IDs in the range 128-255 to avoid conflicts with standard types.

Examples

use nectar_primitives::ChunkTypeId;

let custom = ChunkTypeId::custom(200);
assert!(custom.is_custom());

pub const fn as_u8(self) -> u8

Get the raw byte value of this type ID.

pub const fn is_standard(self) -> bool

Check if this is a standard (reserved) type ID.

Standard types have IDs in the range 0-127.

pub const fn is_custom(self) -> bool

Check if this is a custom type ID.

Custom types have IDs in the range 128-255.

pub const fn name(self) -> Option<&'static str>

Get the human-readable name for known type IDs.

Returns None for unknown or custom types.

pub const fn abbreviation(self) -> Option<&'static str>

Get the abbreviated name for known type IDs.

Returns common abbreviations like “CAC” for content-addressed chunks and “SOC” for single-owner chunks. Returns None for unknown or custom types.

Examples

use nectar_primitives::ChunkTypeId;

assert_eq!(ChunkTypeId::CONTENT.abbreviation(), Some("CAC"));
assert_eq!(ChunkTypeId::SINGLE_OWNER.abbreviation(), Some("SOC"));
assert_eq!(ChunkTypeId::custom(200).abbreviation(), None);

Trait Implementations

impl Clone for ChunkTypeId

fn clone(&self) -> ChunkTypeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ChunkTypeId

impl Debug for ChunkTypeId

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

Formats the value using the given formatter.

impl Display for ChunkTypeId

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

Formats the value using the given formatter.

impl Eq for ChunkTypeId

impl From<ChunkTypeId> for u8

fn from(id: ChunkTypeId) -> Self

Converts to this type from the input type.

impl From<u8> for ChunkTypeId

fn from(id: u8) -> Self

Converts to this type from the input type.

impl Hash for ChunkTypeId

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ChunkTypeId

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