Struct ComponentId 

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

A component identifier in the XMTP app data system.

ComponentIds occupy the top half of the u16 space (0x8000-0xFFFF), split between XMTP protocol use (0x8000-0xBFFF) and application-defined components (0xC000-0xFEFF), with 0xFF00-0xFFFF reserved.

Immutable ranges sit at the end of each block (last 512 IDs, counting down). Components in these ranges can be written once but never updated or deleted.

Implementations

impl ComponentId

pub const COMPONENT_REGISTRY: ComponentId

The component registry. Super admin only.

pub const SUPER_ADMIN_LIST: ComponentId

The super admin list. Super admin only.

pub const ADMIN_LIST: ComponentId

The admin list. Configurable: super admin only or admin/super admin.

pub const GROUP_MEMBERSHIP: ComponentId

pub const GROUP_NAME: ComponentId

pub const GROUP_DESCRIPTION: ComponentId

pub const GROUP_IMAGE_URL: ComponentId

pub const MESSAGE_DISAPPEAR_FROM_NS: ComponentId

pub const MESSAGE_DISAPPEAR_IN_NS: ComponentId

pub const APP_DATA: ComponentId

pub const MIN_SUPPORTED_PROTOCOL_VERSION: ComponentId

pub const COMMIT_LOG_SIGNER: ComponentId

pub const USER_DISPLAY_NAME: ComponentId

Per-inbox display names: TlsMap<InboxId, UTF-8 bytes>.

pub const GROUP_IMAGE: ComponentId

Opaque group image bytes, such as a remote attachment descriptor.

pub const CONVERSATION_TYPE: ComponentId

pub const CREATOR_INBOX_ID: ComponentId

pub const DM_MEMBERS: ComponentId

pub const ONESHOT_MESSAGE: ComponentId

pub const GROUP_ROOT_KEY: ComponentId

The 32-byte group root that every key of the group derives from. Written once at creation; a restored placeholder has none.

pub const WELL_KNOWN_NAMES: [(ComponentId, &'static str); 19]

Every well-known component and its META section 2 name, in ID order, built from xmtp_configuration::WELL_KNOWN_COMPONENT_NAMES.

pub fn from_well_known_name(name: &str) -> Option<ComponentId>

The well-known component with exactly this name.

pub const fn new(id: u16) -> ComponentId

pub const fn as_u16(self) -> u16

pub fn event_name(self) -> String

Name this component in a metadata change event.

pub const fn is_in_component_space(self) -> bool

Returns true if the ID is in the component ID space (top half of u16). Note: this includes the reserved range (0xFF00-0xFFFF); use is_reserved to distinguish.

pub const fn is_xmtp_range(self) -> bool

Returns true if the ID is in the XMTP protocol range (0x8000-0xBFFF).

pub const fn is_app_range(self) -> bool

Returns true if the ID is in the application range (0xC000-0xFEFF).

pub const fn is_reserved(self) -> bool

Returns true if the ID is in the reserved range (0xFF00-0xFFFF).

pub const fn is_immutable(self) -> bool

Returns true if the ID is in an immutable range. Immutable components can be inserted once but never updated or deleted.

pub const fn is_hardcoded(self) -> bool

Returns true if this is one of the hardcoded components whose permissions are enforced in code rather than the component registry.

pub const fn is_constrained(self) -> bool

Returns true if this component has constrained permission values. Constrained components can only have their permissions set to the proto base policies AllowIfAdmin (admin or super admin) or AllowIfSuperAdmin (super admin only).

Trait Implementations

impl Clone for ComponentId

fn clone(&self) -> ComponentId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ComponentId

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

Formats the value using the given formatter.

impl Deserialize for ComponentId

fn tls_deserialize<R>(bytes: &mut R) -> Result<ComponentId, Error>

where R: Read, ComponentId: Sized,

This function deserializes the bytes from the provided a std::io::Read and returns the populated struct.

fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl Display for ComponentId

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

Formats the value using the given formatter.

impl From<ComponentId> for u16

fn from(id: ComponentId) -> u16

Converts to this type from the input type.

impl From<u16> for ComponentId

fn from(id: u16) -> ComponentId

Converts to this type from the input type.

impl Hash for ComponentId

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

where __H: Hasher,

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 Ord for ComponentId

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ComponentId

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

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

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ComponentId

fn tls_serialize<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Serialize self and return it as a byte vector.

impl Size for ComponentId

fn tls_serialized_len(&self) -> usize

impl Copy for ComponentId

impl Eq for ComponentId

impl StructuralPartialEq for ComponentId