Struct cassandra_protocol::frame::Envelope

pub struct Envelope {
    pub version: Version,
    pub direction: Direction,
    pub flags: Flags,
    pub opcode: Opcode,
    pub stream_id: StreamId,
    pub body: Vec<u8>,
    pub tracing_id: Option<Uuid>,
    pub warnings: Vec<String>,
}

Fields

version: Version

direction: Direction

flags: Flags

opcode: Opcode

stream_id: StreamId

body: Vec<u8>

tracing_id: Option<Uuid>

warnings: Vec<String>

Implementations

impl Envelope

pub fn new_req_auth_response(token_bytes: CBytes, version: Version) -> Envelope

Creates new envelope of type AuthResponse.

impl Envelope

pub fn new_req_batch( query: BodyReqBatch, flags: Flags, version: Version ) -> Envelope

impl Envelope

pub fn new_req_execute( id: &CBytesShort, result_metadata_id: Option<&CBytesShort>, query_parameters: &QueryParams, flags: Flags, version: Version ) -> Envelope

impl Envelope

pub fn new_req_options(version: Version) -> Envelope

Creates new envelope of type options.

impl Envelope

pub fn new_req_prepare( query: String, keyspace: Option<String>, flags: Flags, version: Version ) -> Envelope

impl Envelope

pub fn new_req_query( query: String, consistency: Consistency, values: Option<QueryValues>, with_names: bool, page_size: Option<CInt>, paging_state: Option<CBytes>, serial_consistency: Option<Consistency>, timestamp: Option<CLong>, keyspace: Option<String>, now_in_seconds: Option<CInt>, flags: Flags, version: Version ) -> Envelope

pub fn new_query( query: BodyReqQuery, flags: Flags, version: Version ) -> Envelope

impl Envelope

pub fn new_req_register( events: Vec<SimpleServerEvent>, version: Version ) -> Envelope

Creates new envelope of type REGISTER.

impl Envelope

pub fn new_req_startup( compression: Option<String>, version: Version ) -> Envelope

Creates new envelope of type startup.

impl Envelope

pub fn new( version: Version, direction: Direction, flags: Flags, opcode: Opcode, stream_id: StreamId, body: Vec<u8>, tracing_id: Option<Uuid>, warnings: Vec<String> ) -> Self

pub fn request_body(&self) -> Result<RequestBody>

pub fn response_body(&self) -> Result<ResponseBody>

pub fn tracing_id(&self) -> &Option<Uuid>

pub fn warnings(&self) -> &[String]

pub fn from_buffer( data: &[u8], compression: Compression ) -> Result<ParsedEnvelope, ParseEnvelopeError>

Parses the raw bytes of a cassandra envelope returning a ParsedEnvelope struct. The typical use case is reading from a buffer that may contain 0 or more envelopes and where the last envelope may be incomplete. The possible return values are:

• Ok(ParsedEnvelope) - The first envelope in the buffer has been successfully parsed.
• Err(ParseEnvelopeError::NotEnoughBytes) - There are not enough bytes to parse a single envelope, Envelope::from_buffer should be recalled when it is possible that there are more bytes.
• Err(_) - The envelope is malformed and you should close the connection as this method does not provide a way to tell how many bytes to advance the buffer in this case.

pub fn check_envelope_size(data: &[u8]) -> Result<usize, CheckEnvelopeSizeError>

pub fn encode_with(&self, compressor: Compression) -> Result<Vec<u8>>

Trait Implementations

impl Clone for Envelope

fn clone(&self) -> Envelope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Envelope

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

Formats the value using the given formatter.

impl Hash for Envelope

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Envelope

fn eq(&self, other: &Envelope) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Envelope

impl StructuralPartialEq for Envelope