StreamBuilder

Struct StreamBuilder 

Source
pub struct StreamBuilder<'a> { /* private fields */ }
Expand description

Builder for configuring a GVSP stream.

Implementations§

Source§

impl<'a> StreamBuilder<'a>

Source

pub fn new(device: &'a mut GigeDevice) -> Self

Create a new builder bound to an opened GigeDevice.

Source

pub fn iface(self, iface: Iface) -> Self

Select the interface used for receiving GVSP packets.

Source

pub fn dest(self, dest: StreamDest) -> Self

Configure the stream destination.

Source

pub fn auto_packet_size(self, enable: bool) -> Self

Enable or disable automatic packet-size negotiation.

Source

pub fn target_mtu(self, mtu: u32) -> Self

Target MTU used when computing the optimal GVSP packet size.

Source

pub fn packet_size(self, size: u32) -> Self

Override the GVSP packet size when automatic negotiation is disabled.

Source

pub fn packet_delay(self, delay: u32) -> Self

Override the GVSP packet delay when automatic negotiation is disabled.

Source

pub fn destination_port(self, port: u16) -> Self

Configure the UDP port used for streaming (defaults to 0 => device chosen).

Source

pub fn multicast(self, group: Option<Ipv4Addr>) -> Self

Configure multicast reception when the device is set to multicast mode.

Source

pub fn rcvbuf_bytes(self, size: usize) -> Self

Custom receive buffer size for the UDP socket.

Source

pub fn channel(self, channel: u32) -> Self

Select the GigE Vision stream channel to configure (defaults to 0).

Source

pub async fn build(self) -> Result<Stream, GenicamError>

Finalise the builder and return a configured Stream.

Trait Implementations§

Source§

impl<'a> From<&'a mut GigeDevice> for StreamBuilder<'a>

Source§

fn from(device: &'a mut GigeDevice) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a> Freeze for StreamBuilder<'a>

§

impl<'a> RefUnwindSafe for StreamBuilder<'a>

§

impl<'a> Send for StreamBuilder<'a>

§

impl<'a> Sync for StreamBuilder<'a>

§

impl<'a> Unpin for StreamBuilder<'a>

§

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

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more