Enum HttpServerAction

pub enum HttpServerAction {
    Bind {
        path: String,
        authenticated: bool,
        local_only: bool,
        cache: bool,
    },
    SecureBind {
        path: String,
        cache: bool,
    },
    Unbind {
        path: String,
    },
    WebSocketBind {
        path: String,
        authenticated: bool,
        extension: bool,
    },
    WebSocketSecureBind {
        path: String,
        extension: bool,
    },
    WebSocketUnbind {
        path: String,
    },
    WebSocketPush {
        channel_id: u32,
        message_type: WsMessageType,
    },
    WebSocketExtPushOutgoing {
        channel_id: u32,
        message_type: WsMessageType,
        desired_reply_type: MessageType,
    },
    WebSocketExtPushData {
        id: u64,
        hyperware_message_type: MessageType,
        blob: Vec<u8>,
    },
    WebSocketClose(u32),
}

crate::Request type sent to http-server:distro:sys in order to configure it.

If a crate::Response is expected, all actions will return a crate::Response with the shape Result<(), HttpServerActionError> serialized to JSON.

Variants

Bind

Bind expects a crate::LazyLoadBlob if and only if cache is TRUE. The crate::LazyLoadBlob should be the static file to serve at this path.

Fields

path: String

authenticated: bool

Set whether the HTTP request needs a valid login cookie, AKA, whether the user needs to be logged in to access this path.

local_only: bool

Set whether crate::Requests can be fielded from anywhere, or only the loopback address.

cache: bool

Set whether to bind the crate::LazyLoadBlob statically to this path. That is, take the crate::LazyLoadBlob bytes and serve them as the response to any request to this path.

SecureBind

SecureBind expects a crate::LazyLoadBlob if and only if cache is TRUE. The crate::LazyLoadBlob should be the static file to serve at this path.

SecureBind is the same as Bind, except that it forces requests to be made from the unique subdomain of the process that bound the path. These requests are always authenticated, and never local_only. The purpose of SecureBind is to serve elements of an app frontend or API in an exclusive manner, such that other apps installed on this node cannot access them. Since the subdomain is unique, it will require the user to be logged in separately to the general domain authentication.

Fields

path: String

cache: bool

Set whether to bind the crate::LazyLoadBlob statically to this path. That is, take the crate::LazyLoadBlob bytes and serve them as the response to any request to this path.

Unbind

Unbind a previously-bound HTTP path

Fields

path: String

WebSocketBind

Bind a path to receive incoming WebSocket connections. Doesn’t need a cache since does not serve assets.

Fields

path: String

authenticated: bool

extension: bool

WebSocketSecureBind

SecureBind is the same as Bind, except that it forces new connections to be made from the unique subdomain of the process that bound the path. These are always authenticated. Since the subdomain is unique, it will require the user to be logged in separately to the general domain authentication.

Fields

path: String

extension: bool

WebSocketUnbind

Unbind a previously-bound WebSocket path

Fields

path: String

WebSocketPush

When sent, expects a crate::LazyLoadBlob containing the WebSocket message bytes to send.

Fields

channel_id: u32

message_type: WsMessageType

WebSocketExtPushOutgoing

When sent, expects a crate::LazyLoadBlob containing the WebSocket message bytes to send. Modifies the crate::LazyLoadBlob by placing into HttpServerAction::WebSocketExtPushData with id taken from this [KernelMessage] and hyperware_message_type set to desired_reply_type.

Fields

channel_id: u32

message_type: WsMessageType

desired_reply_type: MessageType

WebSocketExtPushData

For communicating with the ext. Hyperware’s http-server sends this to the ext after receiving HttpServerAction::WebSocketExtPushOutgoing. Upon receiving reply with this type from ext, http-server parses, setting:

• id as given,
• message type as given (crate::Request or crate::Response),
• body as HttpServerRequest::WebSocketPush,
• crate::LazyLoadBlob as given.

Fields

id: u64

hyperware_message_type: MessageType

blob: Vec<u8>

WebSocketClose(u32)

Sending will close a socket the process controls.

Trait Implementations

impl Clone for HttpServerAction

fn clone(&self) -> HttpServerAction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpServerAction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpServerAction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HttpServerAction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.