suweal - v0.3.0

suweal

Types

Connection

</>

A connection to a SurrealDB instance.

pub type Connection {
  Connection(
    endpoint: String,
    namespace: String,
    database: String,
    authorization: String,
  )
}

Constructors 

  • Connection(
  endpoint: String,
  namespace: String,
  database: String,
  authorization: String,
)

DecodeCredentialsError

</>

The error type for decoding the Basic authorization header of a connection.

pub type DecodeCredentialsError {
  InvalidBase64
  InvalidFormat
}

Constructors 

  • InvalidBase64
  • InvalidFormat

SurrealError

</> 
pub type SurrealError {
  InvalidUrl
  HttpError(httpc.HttpError)
  ErrorResponse(
    code: Int,
    details: String,
    description: String,
    information: String,
  )
  FailedToDecode(json.DecodeError)
  NoResponse
}

Constructors 

  • InvalidUrl
  • HttpError(httpc.HttpError)
  • ErrorResponse(
  code: Int,
  details: String,
  description: String,
  information: String,
)
  • FailedToDecode(json.DecodeError)
  • NoResponse

SurrealResponse

</> 
pub type SurrealResponse(a) {
  SurrealResponse(
    time: String,
    type_: option.Option(String),
    result: option.Option(a),
  )
  SurrealErrorResponse(
    kind: String,
    type_: option.Option(String),
    time: String,
    details: dynamic.Dynamic,
    result: String,
  )
}

Constructors

Values

auth_result_decoder

</> 
pub fn auth_result_decoder() -> decode.Decoder(
  Result(String, SurrealError),
)

connection

</> 
pub fn connection(
  endpoint endpoint: String,
  namespace namespace: String,
  database database: String,
  username username: String,
  password password: String,
) -> Connection

Create a new connection to a SurrealDB instance with the given endpoint, namespace, database, username and password. The username and password will be used to generate a Basic Authorization header for the connection.

decode_credentials

</> 
pub fn decode_credentials(
  connection: Connection,
) -> Result(#(String, String), DecodeCredentialsError)

Decode the Basic authorization header of a connection into a tuple of username and password.

expect_single_result

</> 
pub fn expect_single_result(
  response: Result(List(SurrealResponse(List(a))), SurrealError),
  msg: String,
) -> a

result_decoder

</> 
pub fn result_decoder(
  decoder: decode.Decoder(a),
) -> decode.Decoder(
  Result(List(SurrealResponse(a)), SurrealError),
)

should_be_error

</> 
pub fn should_be_error(response: SurrealResponse(a)) -> Nil

should_be_success

</> 
pub fn should_be_success(
  response: SurrealResponse(a),
) -> option.Option(a)

status

</> 
pub fn status(connection: Connection) -> Bool

surreal_error_decoder

</> 
pub fn surreal_error_decoder() -> decode.Decoder(SurrealError)

surreal_response_decoder

</> 
pub fn surreal_response_decoder(
  decoder: decode.Decoder(a),
) -> decode.Decoder(SurrealResponse(a))

with_database

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

Replace the database of a connection with a new database. This is useful for switching between different databases in the same SurrealDB instance.

with_namespace

</> 
pub fn with_namespace(
  connection: Connection,
  namespace: String,
) -> Connection

Replace the namespace of a connection with a new namespace. This is useful for switching between different namespaces in the same SurrealDB instance.

✨ Search Document