Crate sn_api

Source

Modules§

files
keys
multimap
nrs
register
req
Request module.
resolver
resp
Response module.
wallet

Structs§

AuthGranted
It represents the authentication response.
AuthReq
Represents an authorisation request.
AuthdStatus
AuthedApp
RegisterAddress
Address of a Register, different from a ChunkAddress in that it also includes a tag.
Safe
SafeAuthdClient
SafeAuthenticator
SafeUrl
Represents a SafeUrl
SectionTree
Container for storing information about other sections in the network.
VersionHash
Version Hash corresponding to the entry hash where the content is stored
XorName
A 256-bit number, viewed as a point in XOR space.

Enums§

ContentType
We encode the content type that a XOR-URL is targetting, this allows the consumer/user to treat the content in particular ways when the content requires it.
DataAddress
An address of data on the network
DataType
We also encode the native SAFE data type where the content is being stored on the SAFE Network, this allows us to fetch the targetted data using the corresponding API, regardless of the data that is being held which is identified by the ContentType instead.
Error
Error type returned by the API
IpcError
Authd Ipc errors.
IpcMsg
IPC message.
IpcReq
IPC request.
IpcResp
IPC response.
Keypair
Wrapper for different keypair types.
PublicKey
Wrapper for different public key types.
SecretKey
Wrapper for different secret key types.
UrlType
An enumeration of possible SafeUrl types.
XorUrlBase
Supported base encoding for XOR URLs

Constants§

DEFAULT_NETWORK_CONTACTS_FILE_NAME
Name of the default network contacts file the Client uses. The file is expected to be found at user’s OS home directory, e.g. in Linux this path would become: $HOME/.safe/network_contacts/default
DEFAULT_XORURL_BASE

Functions§

derive_location_and_keypair
Perform all derivations and seeding to deterministically obtain location and Keypair from input
derive_secrets
Derive Passphrase, Password and Salt (in order).
generate_network_address
Generates User’s Identity for the network using supplied credentials in a deterministic way. This is similar to the username in various places.

Type Aliases§

AuthAllowPrompt
AuthedAppsList
PendingAuthReqs
Result
SafeAuthReq
SafeAuthReqId
XorUrl
The XOR-URL type