Struct MaExtension 

pub struct MaExtension { /* private fields */ }

Fluent builder for the opaque ma: IPLD extension field on a Document.

MaExtension collects the node type, transport service strings, and any custom IPLD fields, then produces the Ipld value ready for Document::set_ma_extension.

The idiomatic way to populate ma: is to start from the endpoint — which pre-populates services — and chain any additional fields:

// Endpoint pre-populates services; add type and any extras:
let ma = endpoint.ma_extension()
    .kind("world");

// Build a complete, signed document in one call:
let document = bundle.build_document(ma)?;

You can also build a MaExtension independently and attach it to an existing document with Document::set_ma_extension before re-signing.

Implementations

impl MaExtension

pub fn new() -> Self

Create an empty extension builder.

pub fn kind(self, kind: &str) -> Self

Set ma["type"] to identify the kind of node or service.

The key name "type" follows the existing convention in the ma ecosystem.

pub fn add_service(self, service: &str) -> Self

Append one transport service string to ma["services"].

Service strings have the form /iroh/<endpoint-id>/ma/<protocol>/<version>.

pub fn services(self, services: Vec<String>) -> Self

Replace ma["services"] with the given list.

Use this (rather than repeated Self::add_service calls) when you already have the full service list, e.g. from crate::MaEndpoint::services.

pub fn extra(self, key: &str, val: Ipld) -> Self

Set an arbitrary IPLD entry in the extension map.

pub fn build(self) -> Ipld

Consume the builder and return the final Ipld value.

Returns Ipld::Null if no fields have been set (which causes Document::set_ma_extension to clear the ma field).

Trait Implementations

impl Clone for MaExtension

fn clone(&self) -> MaExtension

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MaExtension

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

Formats the value using the given formatter.

impl Default for MaExtension

fn default() -> MaExtension

Returns the “default value” for a type.