suweal - v0.3.1

suweal/wss/surreal_wss

Types

SurrealWssConnection

</> 
pub type SurrealWssConnection {
  SurrealWssConnection(
    subject: process.Subject(
      collie.WebsocketMessage(SurrealWssMessage),
    ),
    connection: suweal.Connection,
  )
}

Constructors

SurrealWssConnectionBuilder

</> 
pub type SurrealWssConnectionBuilder {
  SurrealWssConnectionBuilder(
    connection: suweal.Connection,
    name: option.Option(
      process.Name(collie.WebsocketMessage(SurrealWssMessage)),
    ),
    on_close: fn(collie.CloseReason) -> Nil,
  )
}

Constructors

SurrealWssError

</> 
pub type SurrealWssError {
  InvalidUrl
  FailedToConnect
}

Constructors 

  • InvalidUrl
  • FailedToConnect

SurrealWssMessage

</> 
pub type SurrealWssMessage {
  Query(
    query: String,
    receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
  )
  Signup(
    collection: String,
    fields: List(#(String, surreal_ql.SurrealQL)),
    receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
  )
  Signin(
    collection: String,
    fields: List(#(String, surreal_ql.SurrealQL)),
    receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
  )
  Use(
    namespace: String,
    database: String,
    receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
  )
}

Constructors

SurrealWssResponse

</> 
pub type SurrealWssResponse(a) {
  AuthResponse(id: Int, result: String)
  ErrorResponse(id: Int, error: SurrealWssResponseError)
  QueryResponse(id: Int, result: List(suweal.SurrealResponse(a)))
  UseResponse(id: Int)
}

Constructors

SurrealWssResponseError

</> 
pub type SurrealWssResponseError {
  SurrealWssResponseError(
    cause: option.Option(String),
    code: Int,
    kind: String,
    message: String,
  )
}

Constructors 

  • SurrealWssResponseError(
  cause: option.Option(String),
  code: Int,
  kind: String,
  message: String,
)

Values

named

</> 
pub fn named(
  builder: SurrealWssConnectionBuilder,
  name: process.Name(collie.WebsocketMessage(SurrealWssMessage)),
) -> SurrealWssConnectionBuilder

new

</> 
pub fn new(
  connection: suweal.Connection,
) -> SurrealWssConnectionBuilder

on_close

</> 
pub fn on_close(
  builder: SurrealWssConnectionBuilder,
  on_close: fn(collie.CloseReason) -> Nil,
) -> SurrealWssConnectionBuilder

send

</> 
pub fn send(
  connection: SurrealWssConnection,
  message: SurrealWssMessage,
) -> Nil

send_query

</> 
pub fn send_query(
  connection: SurrealWssConnection,
  query: String,
  receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
) -> Nil

send_signin

</> 
pub fn send_signin(
  connection: SurrealWssConnection,
  collection: String,
  fields: List(#(String, surreal_ql.SurrealQL)),
  receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
) -> Nil

send_signup

</> 
pub fn send_signup(
  connection: SurrealWssConnection,
  collection: String,
  fields: List(#(String, surreal_ql.SurrealQL)),
  receiver: process.Subject(SurrealWssResponse(dynamic.Dynamic)),
) -> Nil

start

</> 
pub fn start(
  builder: SurrealWssConnectionBuilder,
) -> Result(SurrealWssConnection, SurrealWssError)

with_database

</> 
pub fn with_database(
  connection: SurrealWssConnection,
  database: String,
) -> SurrealWssConnection

with_namespace

</> 
pub fn with_namespace(
  connection: SurrealWssConnection,
  namespace: String,
) -> SurrealWssConnection
✨ Search Document