#github.com/xulang-org/packages/cassandra

struct Client

pub struct Client {
    pub host string
    pub port int
    pub keyspace string
}

Purpose

Public struct `Client`.

Parameters

host string

host

port int

port

keyspace string

field (string)

new_client

pub fn new_client(endpoint string, keyspace string) Client

Purpose

Construct client.

Parameters

endpoint string

endpoint (string)

keyspace string

keyspace (string)

Returns

Client — a value of this type

(Client) read_frame

pub fn (c Client) read_frame(fd int) Frame

Purpose

Method on `Client`: read frame. Throws on failure.

Parameters

c Client

receiver Client (value receiver)

fd int

file descriptor (int)

Returns

Frame — a value of this type

(Client) connect

pub fn (c Client) connect() int

Purpose

Call `connect` on `Client`. Throws on failure.

Parameters

c Client

receiver Client (value receiver)

Returns

int — a value of this type

(Client) execute_on_fd

pub fn (c Client) execute_on_fd(fd int, cql string) string

Purpose

Method on `Client`: execute on fd. Throws on failure.

Parameters

c Client

receiver Client (value receiver)

fd int

file descriptor (int)

cql string

cql (string)

Returns

string — result string

(Client) execute

pub fn (c Client) execute(cql string) string

Purpose

Call `execute` on `Client`. Throws on failure.

Parameters

c Client

receiver Client (value receiver)

cql string

cql (string)

Returns

string — result string

struct Pool

pub struct Pool {
    pub client Client
    pub idle chan int
    pub max_idle int
}

Purpose

Public struct `Pool`.

Parameters

client Client

field (Client)

idle chan int

field (channel; type chan int)

max_idle int

field (int)

new_pool

pub fn new_pool(endpoint string, keyspace string, max_idle int) Pool

Purpose

Construct pool.

Parameters

endpoint string

endpoint (string)

keyspace string

keyspace (string)

max_idle int

max_idle (int)

Returns

Pool — a value of this type

open_pool

pub fn open_pool(endpoint string, keyspace string, max_idle int) Pool

Purpose

Open pool.

Parameters

endpoint string

endpoint (string)

keyspace string

keyspace (string)

max_idle int

max_idle (int)

Returns

Pool — a value of this type

(&Pool) get_conn

pub fn (p &Pool) get_conn() int

Purpose

Method on `&Pool`: read conn.

Parameters

p &Pool

receiver &Pool (borrow)

Returns

int — a value of this type

(&Pool) put_conn

pub fn (p &Pool) put_conn(fd int)

Purpose

Method on `&Pool`: put connection.

Parameters

p &Pool

receiver &Pool (borrow)

fd int

file descriptor (int)

(&Pool) execute

pub fn (p &Pool) execute(cql string) string

Purpose

Call `execute` on `&Pool`. Throws on failure.

Parameters

p &Pool

receiver &Pool (borrow)

cql string

cql (string)

Returns

string — result string

(&Pool) close

pub fn (p &Pool) close()

Purpose

Method on `&Pool`: close the resource.

Parameters

p &Pool

receiver &Pool (borrow)

const opcode_error

pub const opcode_error = 0

Purpose

Public constant `opcode_error`. Value `0`.

Parameters

none

const opcode_startup

pub const opcode_startup = 1

Purpose

Public constant `opcode_startup`. Value `1`.

Parameters

none

const opcode_ready

pub const opcode_ready = 2

Purpose

Public constant `opcode_ready`. Value `2`.

Parameters

none

const opcode_authenticate

pub const opcode_authenticate = 3

Purpose

Public constant `opcode_authenticate`. Value `3`.

Parameters

none

const opcode_query

pub const opcode_query = 7

Purpose

Public constant `opcode_query`. Value `7`.

Parameters

none

const opcode_result

pub const opcode_result = 8

Purpose

Public constant `opcode_result`. Value `8`.

Parameters

none

const result_kind_void

pub const result_kind_void = 1

Purpose

Public constant `result_kind_void`. Value `1`.

Parameters

none

const result_kind_rows

pub const result_kind_rows = 2

Purpose

Public constant `result_kind_rows`. Value `2`.

Parameters

none

const result_kind_set_keyspace

pub const result_kind_set_keyspace = 3

Purpose

Public constant `result_kind_set_keyspace`. Value `3`.

Parameters

none

const result_kind_prepared

pub const result_kind_prepared = 4

Purpose

Public constant `result_kind_prepared`. Value `4`.

Parameters

none

const result_kind_schema_change

pub const result_kind_schema_change = 5

Purpose

Public constant `result_kind_schema_change`. Value `5`.

Parameters

none

struct Frame

pub struct Frame {
    pub version int
    pub flags int
    pub stream int
    pub opcode int
    pub body string
}

Purpose

Public struct `Frame`.

Parameters

version int

field (int)

flags int

field (int)

stream int

field (int)

opcode int

field (int)

body string

body

encode_u16

pub fn encode_u16(val int) string

Purpose

Encode.

Parameters

val int

value (int)

Returns

string — result string

encode_u32

pub fn encode_u32(val int) string

Purpose

Encode.

Parameters

val int

value (int)

Returns

string — result string

decode_u16

pub fn decode_u16(b1 int, b2 int) int

Purpose

Decode.

Parameters

b1 int

b1 (int)

b2 int

b2 (int)

Returns

int — a value of this type

decode_u32

pub fn decode_u32(b1 int, b2 int, b3 int, b4 int) int

Purpose

Decode.

Parameters

b1 int

b1 (int)

b2 int

b2 (int)

b3 int

b3 (int)

b4 int

b4 (int)

Returns

int — a value of this type

build_frame

pub fn build_frame(opcode int, stream int, body string) string

Purpose

Build frame.

Parameters

opcode int

opcode (int)

stream int

stream (int)

body string

body (string)

Returns

string — result string

build_startup_frame

pub fn build_startup_frame() string

Purpose

Build startup frame.

Parameters

none

Returns

string — result string

build_query_frame

pub fn build_query_frame(cql string, stream int) string

Purpose

Build query frame.

Parameters

cql string

cql (string)

stream int

stream (int)

Returns

string — result string