Struct bancho_packets::PacketBuilder

pub struct PacketBuilder { /* private fields */ }

PacketBuilder can help pack bancho packets.

Usages:

use bancho_packets::{server, PacketBuilder, LoginResult};

let packet = PacketBuilder::new()
    .add(server::login_reply(LoginResult::Success(1009)))
    .add(server::protocol_version(19))
    .add(server::notification("Welcome to osu!"))
    .add(server::main_menu_icon(
        "https://image.png",
        "https://url.link",
    ))
    .add(server::silence_end(0))
    .add(server::channel_info_end())
    .build();

Implementations

impl PacketBuilder

pub fn new() -> Self

Create an empty PacketBuilder.

pub fn with_capacity(capacity: usize) -> Self

Create PacketBuilder with capacity.

pub fn with_packet_id(packet_id: PacketId) -> Self

Create PacketBuilder with PacketId.

pub fn build(self) -> Vec<u8>

Consume this PacketBuilder and return data.

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

pub fn buffer_mut(&mut self) -> &mut Vec<u8>

pub fn from_batch<P, I>(packets: P) -> Selfwhere
    I: IntoIterator<Item = u8>,
    P: IntoIterator<Item = I>,

Create a PacketBuilder from multiple packets.

pub fn add_batch<P, I>(self, packets: P) -> Selfwhere
    I: IntoIterator<Item = u8>,
    P: IntoIterator<Item = I>,

Batch add packets to PacketBuilder.

pub fn add_batch_ref<P, I>(&mut self, packets: P) -> &Selfwhere
    I: IntoIterator<Item = u8>,
    P: IntoIterator<Item = I>,

Batch add packets to PacketBuilder.

pub fn add<P>(self, packet: P) -> Selfwhere
    P: IntoIterator<Item = u8>,

Add an packet to PacketBuilder.

pub fn add_ref<P>(&mut self, packet: P) -> &Selfwhere
    P: IntoIterator<Item = u8>,

Add an packet to PacketBuilder.

Trait Implementations

impl Clone for PacketBuilder

fn clone(&self) -> PacketBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PacketBuilder

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

Formats the value using the given formatter.

impl From<Vec<u8, Global>> for PacketBuilder

fn from(buffer: Vec<u8>) -> Self

Converts to this type from the input type.