Struct holochain_core_types::agent::AgentId

pub struct AgentId {
    pub nick: String,
    pub pub_sign_key: Base32,
}

AgentId represents an agent in the Holochain framework. This data struct is meant be stored in the CAS and source-chain. Its key is the public signing key, and is also used as its address.

Fields

nick: String

a nickname for referencing this agent

pub_sign_key: Base32

the encoded public signing key of this agent (the magnifier)

Methods

impl AgentId

pub const FAKE_RAW_KEY: [u8; 32]

A well-known key useful for testing and used by generate_fake()

pub fn generate_fake(nick: &str) -> Self

generate an agent id with fake key

pub fn new_with_raw_key(nick: &str, key: &str) -> HcResult<Self>

initialize an Agent struct with nick and key that will be encoded with HCID.

pub fn new(nick: &str, key_b32: Base32) -> Self

initialize an Agent struct with nick and a HCID encoded key.

pub fn decoded_key(&self) -> HcResult<String>

Get the key decoded with HCID

Trait Implementations

impl AddressableContent for AgentId

fn address(&self) -> Address

for an Agent, the address is their public base32 encoded public signing key string

fn content(&self) -> Content

get the entry content

fn try_from_content(content: &Content) -> JsonResult<Self>

restore/deserialize the original struct/type from serialized Content the default implementation covers anything that implements From for Foo

impl Clone for AgentId

fn clone(&self) -> AgentId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AgentId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AgentId

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

Deserialize this value from the given Serde deserializer.

impl Eq for AgentId

impl<'a> From<&'a AgentId> for JsonString

fn from(v: &AgentId) -> JsonString

Performs the conversion.

impl From<AgentId> for JsonString

fn from(v: AgentId) -> JsonString

Performs the conversion.

impl PartialEq<AgentId> for AgentId

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

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

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

This method tests for !=.

impl Serialize for AgentId

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

Serialize this value into the given Serde serializer.

impl StructuralEq for AgentId

impl StructuralPartialEq for AgentId

impl<'a> TryFrom<&'a JsonString> for AgentId

type Error = JsonError

The type returned in the event of a conversion error.

fn try_from(json_string: &JsonString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<JsonString> for AgentId

type Error = JsonError

The type returned in the event of a conversion error.

fn try_from(json_string: JsonString) -> Result<Self, Self::Error>

Performs the conversion.