Struct Packeteer

pub struct Packeteer<'a> { /* private fields */ }

Expand description

An iterator-like object that yields packets from the game as they occur.

Implementations§

impl<'a> Packeteer<'a>

pub fn next(&mut self) -> Result<GameTickPacket, Box<dyn Error>>

Blocks until we receive the next unique GameTickPacket, and then returns it.

§Errors

This function returns an error if ten seconds pass without a new packet being received. The assumption is that the game froze or crashed, and waiting longer will not help.

pub fn try_next(&mut self) -> Option<GameTickPacket>

Polls for the next unique GameTickPacket.

If there is a packet that is newer than the previous packet, it is returned. Otherwise, None is returned.

pub fn next_ffi(&mut self) -> Result<LiveDataPacket, Box<dyn Error>>

👎Deprecated: the struct-based methods are deprecated; use the flatbuffer equivalents instead

Blocks until we receive the next unique ffi::LiveDataPacket, and then returns it.

§Errors

This function returns an error if ten seconds pass without a new packet being received. The assumption is that the game froze or crashed, and waiting longer will not help.

pub fn try_next_ffi(&mut self) -> Result<Option<LiveDataPacket>, Box<dyn Error>>

👎Deprecated: the struct-based methods are deprecated; use the flatbuffer equivalents instead

Polls for the next unique ffi::LiveDataPacket.

If there is a packet that is newer than the previous packet, it is returned. Otherwise, None is returned.

pub fn next_flatbuffer<'fb>( &mut self, ) -> Result<GameTickPacket<'fb>, Box<dyn Error>>

Blocks until we receive the next unique flat::GameTickPacket, and then returns it.

§Errors

This function returns an error if ten seconds pass without a new packet being received. The assumption is that the game froze or crashed, and waiting longer will not help.

pub fn try_next_flat<'fb>(&mut self) -> Option<GameTickPacket<'fb>>

Polls for the next unique flat::GameTickPacket.

If there is a packet that is newer than the previous packet, it is returned. Otherwise, None is returned.

Auto Trait Implementations§

impl<'a> Freeze for Packeteer<'a>

impl<'a> !RefUnwindSafe for Packeteer<'a>

impl<'a> !Send for Packeteer<'a>

impl<'a> !Sync for Packeteer<'a>

impl<'a> Unpin for Packeteer<'a>

impl<'a> !UnwindSafe for Packeteer<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.