Struct bililive_core::packet::Packet

pub struct Packet { /* fields omitted */ }

Bililive packet.

Packet can be used to encode/parse raw bilibili live packets, and extract information from it.

Implementations

impl Packet

pub fn set_proto(&mut self, protocol_version: Protocol)

Set the protocol version.

pub fn set_op(&mut self, op: Operation)

Set the operation.

pub fn set_seq_id(&mut self, seq_id: u32)

Set the sequence id. By default it’s 1.

pub fn set_data<T: Into<Vec<u8>>>(&mut self, data: T)

Set the packet body. Packet length will be updated automatically.

impl Packet

pub fn new<T: Into<Vec<u8>>>(
    op: Operation,
    protocol_version: Protocol,
    data: T
) -> Self

Construct a new packet.

To construct a zlib-compressed packet, you should create a JSON/Int32BE packet first, then call Packet::compress to convert it to a zlib one.

pub fn compress(self) -> Result<Self, ParseError>

Convert a JSON/Int32BE packet to a zlib-compressed one.

Errors

Return errors if compression fails.

impl Packet

pub fn new_room_enter(config: &StreamConfig) -> Self

impl Packet

pub const fn packet_length(&self) -> u32

Get the packet length.

pub const fn header_length(&self) -> u16

Get the header length.

pub const fn seq_id(&self) -> u32

Get the sequence id.

pub const fn op(&self) -> Operation

Get the operation.

pub const fn proto(&self) -> Protocol

Get the protocol version.

pub fn bytes(&self) -> &[u8]

Get bytes of the body.

pub fn json<'a, T: Deserialize<'a>>(&'a self) -> Result<T, ParseError>

Try to parse the body by json.

Errors

It may fail if the model is incorrect or it’s not a json packet. You may check the type of the packet by Packet::proto.

pub fn int32_be(&self) -> Result<i32, ParseError>

Try to parse the body by big endian int32.

Errors

It may fail if it’s not a int packet. You may check the type of the packet by Packet::proto.

impl Packet

pub fn encode(&self) -> Vec<u8>

Encode the packet into bytes ready to be sent to the server.

pub fn parse(input: &[u8]) -> IncompleteResult<(&[u8], Self)>

Parse the packet received from Bilibili server.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Hash for Packet

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Packet> for Packet

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

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

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

This method tests for !=.

impl<T, E> Sink<Packet> for HeartbeatStream<T, E> where
    T: Sink<Packet, Error = StreamError<E>> + Unpin,
    E: Error, 

type Error = StreamError<E>

The type of value produced by the sink when an error occurs.

fn poll_ready(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value.

fn start_send(self: Pin<&mut Self>, item: Packet) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())).

fn poll_flush(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink.

fn poll_close(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary.

impl Eq for Packet

impl StructuralEq for Packet

impl StructuralPartialEq for Packet