Struct valence_network::ServerListLegacyPingResponse

pub struct ServerListLegacyPingResponse { /* private fields */ }

Response data of the legacy server list ping.

Example

let mut response =
    ServerListLegacyPingResponse::new(127, 0, 10).version("Valence 1.20.1".to_owned());

// This will make the description just repeat "hello" until the length limit
// (which depends on the other fields that we set above: protocol, version,
// online players, max players).
let max_description = response.max_description();
response = response.description(
    std::iter::repeat("hello ")
        .flat_map(|s| s.chars())
        .take(max_description)
        .collect(),
);

Implementations

impl ServerListLegacyPingResponse

pub fn new(protocol: i32, online_players: i32, max_players: i32) -> Self

Constructs a new basic ServerListLegacyPingResponse.

See description and version.

pub fn description(self, description: String) -> Self

Sets the description of the server.

If the resulting response packet is too long to be valid, the description will be truncated.

Use max_description method to get the max valid length for this specific packet with the already set fields (version, protocol, online players, max players).

Also any null bytes will be removed.

pub fn version(self, version: String) -> Self

Sets the version of the server.

If the resulting response packet is too long to be valid, the version will be truncated.

Use max_version method to get the max valid length for this specific packet with the already set fields (description, protocol, online players, max players).

Also any null bytes will be removed.

pub fn max_description(&self) -> usize

Returns the maximum number of characters (not bytes) that this packet’s description can have with all other fields set as they are.

pub fn max_version(&self) -> usize

Returns the maximum number of characters (not bytes) that this packet’s version can have with all other fields set as they are.

Trait Implementations

impl Clone for ServerListLegacyPingResponse

fn clone(&self) -> ServerListLegacyPingResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ServerListLegacyPingResponse

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

Formats the value using the given formatter.

impl Default for ServerListLegacyPingResponse

fn default() -> ServerListLegacyPingResponse

Returns the “default value” for a type.

impl PartialEq for ServerListLegacyPingResponse

fn eq(&self, other: &ServerListLegacyPingResponse) -> 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 StructuralPartialEq for ServerListLegacyPingResponse