Struct enet::Enet

pub struct Enet { /* fields omitted */ }

Main API entry point. Provides methods such as host and peer creation.

Creating an instance of this struct for the first time (using new()) will initialize ENet. Further attempts to create instances will result in errors, so it can only be constructed once (but it can be cloned).

This struct can be used to performs most top-level ENet functionality, such as host creation and connection establishment.

Methods

impl Enet

pub fn new() -> Result<Enet, InitializationError>

Initializes ENet and returns a handle to the top-level functionality, in the form of an Enet-instance.

pub fn create_host<T>(
    &self,
    address: Option<&Address>,
    max_peer_count: usize,
    max_channel_count: ChannelLimit,
    incoming_bandwidth: BandwidthLimit,
    outgoing_bandwidth: BandwidthLimit
) -> Result<Host<T>, Error>

Creates a Host. A Host is an endpoint of an ENet connection. For more information consult the official ENet-documentation.

address specifies the address to listen on. Client-only endpoints can choose None. max_channel_count will be set to its (ENet-specified) default value if None.

The type T specifies the data associated with corresponding Peers.

Trait Implementations

impl Clone for Enet

fn clone(&self) -> Enet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Enet

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

Formats the value using the given formatter.