Struct sn_api::nrs::NrsMap

pub struct NrsMap {
    pub map: BTreeMap<String, SafeUrl>,
}

An NRS map is a description of a registered topname and all subnames associated with that.

Each subname will link to some content, e.g., a FilesContainer, and the topname can also optionally link to something.

The struct is stored on the network using a Multimap. The entries are public name -> SafeUrl mappings.

PublicName Key	Full Name	SafeUrl Value
“example”	“example”	“safe://example”
“sub.example”	“sub.example”	“safe://sub.example”
“sub.sub.example”	“sub.sub.example”	“safe://sub.sub.example”

The map also has a subname version field that optionally specifies a subname at a particular version, since it’s possible to have multiple entries for a given subname. If no version was requested when the map is retrieved, it will be set to None.

Fields

map: BTreeMap<String, SafeUrl>

Implementations

impl NrsMap

pub fn get(&self, public_name: &str) -> Result<Option<SafeUrl>>

Get the SafeUrl associated with the given public name.

There are 3 possible inputs for public_name:

• The topname, e.g., “example”.
• A subname with a topname, e.g. “a.example”.
• An XorUrl string.

The calling nrs_get function would have already returned if it couldn’t find, say, “example2”.

If public_name isn’t in the map, we then check to see if it contains subnames, in which case, we return a ContentError. If it doesn’t, we return None. At this point, either the topname has no link associated, or we have an XorUrl string. In both cases, the resolver is going to return the NrsMapContainer content.

We’re doing this because we want to return no target link if the address of the container has been passed to nrs_get.

pub fn get_map_summary(&self) -> Vec<(String, String)>

Prints a summary for the NRS map.

This is used in the CLI for printing out the details of a map.

It sorts by the length of the subname, so you’d end up with something like this:

• example
• a.example
• a.b.example
• subname.example

Trait Implementations

impl Clone for NrsMap

fn clone(&self) -> NrsMap

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NrsMap

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

Formats the value using the given formatter.

impl Default for NrsMap

fn default() -> NrsMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NrsMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<NrsMap> for NrsMap

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NrsMap

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

Serialize this value into the given Serde serializer.

impl Eq for NrsMap

impl StructuralEq for NrsMap

impl StructuralPartialEq for NrsMap