Struct Channel 

pub struct Channel {
    framed: Framed<TcpStream, ObjectCodec>,
    version: Version,
}

A channel to a gpsd server.

The channel acts as a [Sink] for Commands and a [Stream] of Objects.

See the module documentation for more information.

Fields

framed: Framed<TcpStream, ObjectCodec>

version: Version

Implementations

impl Channel

pub async fn connect_localhost() -> Result<Self, Error>

Connects to a gpsd server running on localhost with the default port.

Errors

Returns an error if the connection or gpsd handshake fails.

pub async fn connect(addr: impl ToSocketAddrs) -> Result<Self, Error>

Connects to a gpsd server at the given address.

Errors

Returns an error if the connection or gpsd handshake fails.

async fn connect_stream(stream: TcpStream) -> Result<Self, Error>

Connects to a gpsd server over an existing TcpStream.

pub const fn version(&self) -> &Version

Returns the version of the gpsd server.

This is the version reported by the server when the connection was established.

Trait Implementations

impl Sink<Command> for Channel

type Error = Error

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: Command) -> 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 Stream for Channel

type Item = Result<Object, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.