Struct MutablePointer 

#[non_exhaustive]
pub struct MutablePointer {
    pub publisher: PublicKey,
    pub alias: String,
    pub sequence: u64,
    pub manifest: Hash,
    pub version: Option<String>,
    pub providers: Vec<ProviderLease>,
    pub signature: Option<String>,
}

A signed mutable pointer to an immutable manifest.

Every accepted pointer has a publisher, alias, sequence, and manifest bound by an Ed25519 signature. A resolver accepts only a sequence greater than the currently accepted sequence for that publisher and alias.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

publisher: PublicKey

Publisher identity; this must match the signing key.

alias: String

Publisher-controlled alias.

sequence: u64

Monotonically increasing update number.

manifest: Hash

Immutable manifest identified by this pointer.

version: Option<String>

Optional semantic version used for version pinning.

providers: Vec<ProviderLease>

Signed provider leases for the manifest.

signature: Option<String>

Hex-encoded Ed25519 signature over the pointer without this field.

Implementations

impl MutablePointer

pub fn new( publisher: PublicKey, alias: impl Into<String>, manifest: Hash, sequence: u64, ) -> Result<Self>

Create an unsigned pointer without provider leases.

Call Self::sign before registering it with a resolver.

Errors

Returns an error if the alias, sequence, or provider data is invalid.

pub fn new_with_providers( publisher: PublicKey, alias: impl Into<String>, manifest: Hash, sequence: u64, providers: Vec<ProviderLease>, ) -> Result<Self>

Create an unsigned pointer with provider leases.

Errors

Returns an error if the alias, sequence, or provider data is invalid.

pub fn signed( publisher: PublicKey, alias: impl Into<String>, manifest: Hash, sequence: u64, signing_key: &SigningKey, ) -> Result<Self>

Create and sign a pointer with a Dalek signing key.

Errors

Returns an error if the pointer is invalid or the signer does not match the publisher.

pub fn signed_with_secret_key( publisher: PublicKey, alias: impl Into<String>, manifest: Hash, sequence: u64, secret_key: &SecretKey, ) -> Result<Self>

Create and sign a pointer with an iroh secret key.

Errors

Returns an error if the pointer is invalid or the signer does not match the publisher.

pub fn with_version(self, version: impl Into<String>) -> Self

Set a semantic version on this pointer.

pub fn with_provider(self, provider: ProviderLease) -> Self

Add a provider lease to this pointer.

pub fn with_providers( self, providers: impl IntoIterator<Item = ProviderLease>, ) -> Self

Add several provider leases to this pointer.

pub fn link(&self) -> Result<NameLink>

Return the corresponding stable name link.

Errors

Returns an error if the alias is invalid.

pub const fn manifest_hash(&self) -> Hash

Return the immutable manifest hash targeted by this pointer.

pub fn unsigned_bytes(&self) -> Result<Vec<u8>>

Serialize the pointer without its signature.

Errors

Returns an error if the pointer is invalid or cannot be serialized.

pub fn sign(&mut self, signing_key: &SigningKey) -> Result<()>

Sign this pointer with an Ed25519 key.

Errors

Returns an error if the signer does not match the publisher or the pointer cannot be serialized.

pub fn verify_signature(&self) -> Result<()>

Verify the pointer’s signature and all provider leases.

Errors

Returns an error if the signature, pointer, or provider lease is invalid.

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

Validate non-cryptographic pointer fields.

Errors

Returns an error if a pointer field or provider lease is invalid.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Encode the signed pointer as JSON.

Errors

Returns an error if the pointer is unsigned, invalid, or cannot be serialized.

pub fn from_bytes(bytes: impl AsRef<[u8]>) -> Result<Self>

Decode and validate a signed pointer.

Errors

Returns an error if the bytes do not contain a valid signed pointer.

Trait Implementations

impl Clone for MutablePointer

fn clone(&self) -> MutablePointer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MutablePointer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MutablePointer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MutablePointer

impl PartialEq for MutablePointer

fn eq(&self, other: &MutablePointer) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MutablePointer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MutablePointer