Enum Opcode

#[repr(C)]
pub enum Opcode {
    Register = 0,
    Lookup = 1,
    AuthenticatedLookup = 2,
    Unregister = 3,
    Disconnect = 4,
    TrustedInitDone = 5,
    BlockingConnect = 6,
    TryConnect = 7,
}

Variants

Register = 0

Create a new server with the given name and return its SID.

Lookup = 1

Create a connection to the target server.

AuthenticatedLookup = 2

Create an authenticated connection to the target server.

Unregister = 3

unregister a server, given its cryptographically unique SID.

Disconnect = 4

disconnect, given a server name and a cryptographically unique, one-time use token

TrustedInitDone = 5

indicates if all inherently trusted slots have been occupied. Should not run untrusted code until this is the case.

BlockingConnect = 6

Connect to a Server, blocking if the Server does not exist. When the Server is started, return with either the CID or an AuthenticationRequest

Message Types

* MutableLend

Arguments

The memory being pointed to should be a &str, and the length of the string should be specified in the valid field.

Return Values

Memory is overwritten to contain a return value. This return value can be defined as the following enum:

#[repr(C)]
#[non_exhaustive]
enum ConnectResult {
    Success(xous::CID /* connection ID */, [u32; 4] /* Disconnection token */),
    Error(u32 /* error code */),
    Unhandled, /* Catchall for future Results */
}

TryConnect = 7

Connect to a Server, returning the connection ID or an authentication request if it exists, and returning ServerNotFound if it does not exist.

Message Types

* MutableLend

Arguments

The memory being pointed to should be a &str, and the length of the string should be specified in the valid field.

Return Values

Memory is overwritten to contain a return value. This return value can be defined as the following enum:

#[repr(C)]
#[non_exhaustive]
enum ConnectResult {
    Success(xous::CID /* connection ID */, [u32; 4] /* Disconnection token */),
    Error(u32 /* error code */),
    Unhandled, /* Catchall for future Results */
}

Trait Implementations

impl FromPrimitive for Opcode

fn from_i64(n: i64) -> Option<Self>

Converts an i64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u64(n: u64) -> Option<Self>

Converts an u64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_isize(n: isize) -> Option<Self>

Converts an isize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i8(n: i8) -> Option<Self>

Converts an i8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i16(n: i16) -> Option<Self>

Converts an i16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i32(n: i32) -> Option<Self>

Converts an i32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_usize(n: usize) -> Option<Self>

Converts a usize to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u8(n: u8) -> Option<Self>

Converts an u8 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u16(n: u16) -> Option<Self>

Converts an u16 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u32(n: u32) -> Option<Self>

Converts an u32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f32(n: f32) -> Option<Self>

Converts a f32 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

fn from_f64(n: f64) -> Option<Self>

Converts a f64 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

impl ToPrimitive for Opcode

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

fn to_u64(&self) -> Option<u64>

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

fn to_u8(&self) -> Option<u8>

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

fn to_u16(&self) -> Option<u16>

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

fn to_u32(&self) -> Option<u32>

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.