Enum safe_nd::Request

pub enum Request {
    PutIData(IData),
    GetIData(IDataAddress),
    DeleteUnpubIData(IDataAddress),
    PutMData(MData),
    GetMData(MDataAddress),
    GetMDataValue {
        address: MDataAddress,
        key: Vec<u8>,
    },
    DeleteMData(MDataAddress),
    GetMDataShell(MDataAddress),
    GetMDataVersion(MDataAddress),
    ListMDataEntries(MDataAddress),
    ListMDataKeys(MDataAddress),
    ListMDataValues(MDataAddress),
    SetMDataUserPermissions {
        address: MDataAddress,
        user: PublicKey,
        permissions: MDataPermissionSet,
        version: u64,
    },
    DelMDataUserPermissions {
        address: MDataAddress,
        user: PublicKey,
        version: u64,
    },
    ListMDataPermissions(MDataAddress),
    ListMDataUserPermissions {
        address: MDataAddress,
        user: PublicKey,
    },
    MutateMDataEntries {
        address: MDataAddress,
        actions: MDataEntryActions,
    },
    PutAData(AData),
    GetAData(ADataAddress),
    GetADataShell {
        address: ADataAddress,
        data_index: ADataIndex,
    },
    DeleteAData(ADataAddress),
    GetADataRange {
        address: ADataAddress,
        range: (ADataIndex, ADataIndex),
    },
    GetADataValue {
        address: ADataAddress,
        key: Vec<u8>,
    },
    GetADataIndices(ADataAddress),
    GetADataLastEntry(ADataAddress),
    GetADataPermissions {
        address: ADataAddress,
        permissions_index: ADataIndex,
    },
    GetPubADataUserPermissions {
        address: ADataAddress,
        permissions_index: ADataIndex,
        user: ADataUser,
    },
    GetUnpubADataUserPermissions {
        address: ADataAddress,
        permissions_index: ADataIndex,
        public_key: PublicKey,
    },
    GetADataOwners {
        address: ADataAddress,
        owners_index: ADataIndex,
    },
    AddPubADataPermissions {
        address: ADataAddress,
        permissions: ADataPubPermissions,
        permissions_index: u64,
    },
    AddUnpubADataPermissions {
        address: ADataAddress,
        permissions: ADataUnpubPermissions,
        permissions_index: u64,
    },
    SetADataOwner {
        address: ADataAddress,
        owner: ADataOwner,
        owners_index: u64,
    },
    AppendSeq {
        append: ADataAppendOperation,
        index: u64,
    },
    AppendUnseq(ADataAppendOperation),
    TransferCoins {
        destination: XorName,
        amount: Coins,
        transaction_id: TransactionId,
    },
    GetBalance,
    CreateBalance {
        new_balance_owner: PublicKey,
        amount: Coins,
        transaction_id: TransactionId,
    },
    CreateLoginPacket(LoginPacket),
    CreateLoginPacketFor {
        new_owner: PublicKey,
        amount: Coins,
        transaction_id: TransactionId,
        new_login_packet: LoginPacket,
    },
    UpdateLoginPacket(LoginPacket),
    GetLoginPacket(XorName),
    ListAuthKeysAndVersion,
    InsAuthKey {
        key: PublicKey,
        version: u64,
        permissions: AppPermissions,
    },
    DelAuthKey {
        key: PublicKey,
        version: u64,
    },
}

RPC Request that is sent to vaults.

Variants

PutIData(IData)

Put ImmutableData.

GetIData(IDataAddress)

Get ImmutableData.

DeleteUnpubIData(IDataAddress)

Delete unpublished ImmutableData.

PutMData(MData)

Put MutableData.

GetMData(MDataAddress)

Get MutableData.

GetMDataValue

Get MutableData value.

Fields of GetMDataValue

address: MDataAddress

MutableData address.

key: Vec<u8>

Key to get.

DeleteMData(MDataAddress)

Delete MutableData.

GetMDataShell(MDataAddress)

Get MutableData shell.

GetMDataVersion(MDataAddress)

Get MutableData version.

ListMDataEntries(MDataAddress)

List MutableData entries.

ListMDataKeys(MDataAddress)

List MutableData keys.

ListMDataValues(MDataAddress)

List MutableData values.

SetMDataUserPermissions

Set MutableData user permissions.

Fields of SetMDataUserPermissions

address: MDataAddress

MutableData address.

user: PublicKey

User to set permissions for.

permissions: MDataPermissionSet

New permissions.

version: u64

Version to set.

DelMDataUserPermissions

Delete MutableData user permissions.

Fields of DelMDataUserPermissions

address: MDataAddress

MutableData address.

user: PublicKey

User to delete permissions for.

version: u64

Version to delete.

ListMDataPermissions(MDataAddress)

List MutableData permissions.

ListMDataUserPermissions

Get MutableData permissions for a user.

Fields of ListMDataUserPermissions

address: MDataAddress

MutableData address.

user: PublicKey

User to get permissions for.

MutateMDataEntries

Mutate MutableData entries.

Fields of MutateMDataEntries

address: MDataAddress

MutableData address.

actions: MDataEntryActions

Mutation actions to perform.

PutAData(AData)

Put a new AppendOnlyData onto the network.

GetAData(ADataAddress)

Get AppendOnlyData from the network.

GetADataShell

Get AppendOnlyData shell at a certain point in history (data_index refers to the list of data).

Fields of GetADataShell

address: ADataAddress

AppendOnlyData address.

data_index: ADataIndex

Index of the data at which to get the shell.

DeleteAData(ADataAddress)

Delete an unpublished AppendOnlyData.

This operation MUST return an error if applied to published AppendOnlyData. Only the current owner(s) can perform this action.

GetADataRange

Get a range of entries from an AppendOnlyData object on the network.

Fields of GetADataRange

address: ADataAddress

AppendOnlyData address.

range: (ADataIndex, ADataIndex)

Range of entries to fetch.

For example, get 10 last entries: range: (Index::FromEnd(10), Index::FromEnd(0))

Get all entries: range: (Index::FromStart(0), Index::FromEnd(0))

Get first 5 entries: range: (Index::FromStart(0), Index::FromStart(5))

GetADataValue

Get AppendOnlyData value.

Fields of GetADataValue

address: ADataAddress

AppendOnlyData address.

key: Vec<u8>

Key to get.

GetADataIndices(ADataAddress)

Get current indices: data, owners, permissions.

GetADataLastEntry(ADataAddress)

Get an entry with the current index.

GetADataPermissions

List all permissions at the provided index.

Fields of GetADataPermissions

address: ADataAddress

AppendOnlyData address.

permissions_index: ADataIndex

Permissions index.

GetPubADataUserPermissions

Get published permissions for a specified user(s).

Fields of GetPubADataUserPermissions

address: ADataAddress

AppendOnlyData address.

permissions_index: ADataIndex

Permissions index.

user: ADataUser

User to get permissions for.

GetUnpubADataUserPermissions

Get unpublished permissions for a specified user(s).

Fields of GetUnpubADataUserPermissions

address: ADataAddress

AppendOnlyData address.

permissions_index: ADataIndex

Permissions index.

public_key: PublicKey

User to get permissions for.

GetADataOwners

Get owners at the provided index.

Fields of GetADataOwners

address: ADataAddress

AppendOnlyData address.

owners_index: ADataIndex

Onwers index.

AddPubADataPermissions

Add a new published permissions entry.

Fields of AddPubADataPermissions

address: ADataAddress

AppendOnlyData address.

permissions: ADataPubPermissions

Published permissions.

permissions_index: u64

Index to add to.

AddUnpubADataPermissions

Add a new unpublished permissions entry.

Fields of AddUnpubADataPermissions

address: ADataAddress

AppendOnlyData address.

permissions: ADataUnpubPermissions

Unpublished permissions.

permissions_index: u64

Index to add to.

SetADataOwner

Add a new owners entry. Only the current owner(s) can perform this action.

Fields of SetADataOwner

address: ADataAddress

AppendOnlyData address.

owner: ADataOwner

New owner.

owners_index: u64

Owners index.

AppendSeq

Append sequenced AppendOnlyData at the given index.

Fields of AppendSeq

append: ADataAppendOperation

Entries to append.

index: u64

Index.

AppendUnseq(ADataAppendOperation)

Append unsequenced AppendOnlyData.

TransferCoins

Balance transfer.

Fields of TransferCoins

destination: XorName

The destination to transfer to.

amount: Coins

The amount in coins to transfer.

transaction_id: TransactionId

The ID of the transaction.

GetBalance

Get current wallet balance.

CreateBalance

Create a new coin balance.

Fields of CreateBalance

new_balance_owner: PublicKey

The new owner of the balance.

amount: Coins

The new balance amount in coins.

transaction_id: TransactionId

The ID of the transaction.

CreateLoginPacket(LoginPacket)

Create a login packet.

CreateLoginPacketFor

Create a login packet for a given user and transfer some initial coins.

Fields of CreateLoginPacketFor

new_owner: PublicKey

The new owner of the login packet.

amount: Coins

The new balance amount in coins.

transaction_id: TransactionId

The ID of the transaction.

new_login_packet: LoginPacket

The new login packet.

UpdateLoginPacket(LoginPacket)

Update a login packet.

GetLoginPacket(XorName)

Get an encrypted login packet.

ListAuthKeysAndVersion

List authorised keys and version stored by Elders.

InsAuthKey

Insert an authorised key (for an app, user, etc.).

Fields of InsAuthKey

key: PublicKey

Authorised key to be inserted

version: u64

Incremented version

permissions: AppPermissions

Permissions

DelAuthKey

Delete an authorised key.

Fields of DelAuthKey

key: PublicKey

Authorised key to be deleted

version: u64

Incremented version

Methods

impl Request

pub fn error_response(&self, error: Error) -> Response

Creates a Response containing an error, with the Response variant corresponding to the Request variant.

Trait Implementations

impl Ord for Request

fn cmp(&self, other: &Request) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<Request> for Request

fn partial_cmp(&self, other: &Request) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Request) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Request) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Request) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Request) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Request> for Request

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

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

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

This method tests for !=.

impl Eq for Request

impl Debug for Request

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

Formats the value using the given formatter.

impl Hash for Request

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Serialize for Request

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Request

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

Deserialize this value from the given Serde deserializer.