Struct AeronUriStringBuilder 

pub struct AeronUriStringBuilder { /* private fields */ }

Implementations

impl AeronUriStringBuilder

pub fn new_zeroed_on_heap() -> Self

creates zeroed struct where the underlying c struct is on the heap

pub fn new_zeroed_on_stack() -> Self

creates zeroed struct where the underlying c struct is on the stack (Use with care)

pub fn params(&self) -> AeronStrToPtrHashMap

pub fn closed(&self) -> bool

pub fn put(&self, key: &CStr, value: &CStr) -> Result<i32, AeronCError>

pub fn put_int32(&self, key: &CStr, value: i32) -> Result<i32, AeronCError>

pub fn put_int64(&self, key: &CStr, value: i64) -> Result<i32, AeronCError>

pub fn get(&self, key: &CStr) -> &str

pub fn sprint(&self, buffer: &mut [u8]) -> Result<i32, AeronCError>

pub fn sprint_as_string(&self, max_length: usize) -> Result<String, AeronCError>

pub fn sprint_into( &self, dst_truncate_to_capacity: &mut String, ) -> Result<i32, AeronCError>

NOTE: allocation friendly method, the string capacity must be set as it will truncate string to capacity it will never grow the string. So if you pass String::new() it will write 0 chars

pub fn set_initial_position( &self, position: i64, initial_term_id: i32, term_length: i32, ) -> Result<i32, AeronCError>

pub fn get_inner(&self) -> *mut aeron_uri_string_builder_t

pub unsafe fn get_inner_mut(&self) -> &mut aeron_uri_string_builder_t

Mutable access to the underlying C struct, minted from &self: nothing prevents two live &mut at once, so the caller must ensure exclusive access for the lifetime of the returned reference.

Safety

No other reference (& or &mut) to the underlying struct may be alive while the returned &mut is in use.

pub fn get_inner_ref(&self) -> &aeron_uri_string_builder_t

impl AeronUriStringBuilder

pub fn ipc() -> Result<Self, AeronCError>

Fresh builder for an aeron:ipc channel.

pub fn udp(endpoint: &str) -> Result<Self, AeronCError>

Fresh builder for an aeron:udp channel with the given endpoint (host:port).

pub fn udp_control( control: &str, mode: ControlMode, ) -> Result<Self, AeronCError>

Fresh builder for an aeron:udp multi-destination channel with the given control endpoint and ControlMode (Dynamic for MDC publications, Manual for MDS subscriptions/publications, Response for response channels).

pub fn init_new(&self) -> Result<i32, AeronCError>

Initialize a new AeronUriStringBuilder. If already initialized, it will close the previous builder to prevent memory leaks.

pub fn init_on_string(&self, uri: &CStr) -> Result<i32, AeronCError>

Initialize AeronUriStringBuilder with an existing URI string. If already initialized, it will close the previous builder.

pub fn build(&self, max_str_length: usize) -> Result<String, AeronCError>

pub fn put_str(&self, key: &CStr, value: &str) -> Result<&Self, AeronCError>

pub fn media(&self, value: Media) -> Result<&Self, AeronCError>

pub fn control_mode(&self, value: ControlMode) -> Result<&Self, AeronCError>

pub fn prefix(&self, value: &str) -> Result<&Self, AeronCError>

pub fn initial_term_id(&self, value: i32) -> Result<&Self, AeronCError>

pub fn term_id(&self, value: i32) -> Result<&Self, AeronCError>

pub fn term_offset(&self, value: i32) -> Result<&Self, AeronCError>

pub fn alias(&self, value: &str) -> Result<&Self, AeronCError>

pub fn term_length(&self, value: &str) -> Result<&Self, AeronCError>

pub fn linger_timeout(&self, value: i64) -> Result<&Self, AeronCError>

pub fn mtu_length(&self, value: i32) -> Result<&Self, AeronCError>

pub fn ttl(&self, value: i32) -> Result<&Self, AeronCError>

pub fn sparse_term(&self, value: bool) -> Result<&Self, AeronCError>

pub fn reliable(&self, value: bool) -> Result<&Self, AeronCError>

pub fn eos(&self, value: bool) -> Result<&Self, AeronCError>

pub fn tether(&self, value: bool) -> Result<&Self, AeronCError>

pub fn tags(&self, value: &str) -> Result<&Self, AeronCError>

pub fn endpoint(&self, value: &str) -> Result<&Self, AeronCError>

pub fn interface(&self, value: &str) -> Result<&Self, AeronCError>

pub fn control(&self, value: &str) -> Result<&Self, AeronCError>

pub fn session_id(&self, value: &str) -> Result<&Self, AeronCError>

pub fn group(&self, value: bool) -> Result<&Self, AeronCError>

pub fn rejoin(&self, value: bool) -> Result<&Self, AeronCError>

pub fn fc(&self, value: &str) -> Result<&Self, AeronCError>

pub fn gtag(&self, value: &str) -> Result<&Self, AeronCError>

pub fn cc(&self, value: &str) -> Result<&Self, AeronCError>

pub fn spies_simulate_connection( &self, value: bool, ) -> Result<&Self, AeronCError>

pub fn ats(&self, value: bool) -> Result<&Self, AeronCError>

pub fn socket_sndbuf(&self, value: i32) -> Result<&Self, AeronCError>

pub fn socket_rcvbuf(&self, value: i32) -> Result<&Self, AeronCError>

pub fn receiver_window(&self, value: i32) -> Result<&Self, AeronCError>

pub fn media_rcv_timestamp_offset( &self, value: &str, ) -> Result<&Self, AeronCError>

pub fn channel_rcv_timestamp_offset( &self, value: &str, ) -> Result<&Self, AeronCError>

pub fn channel_snd_timestamp_offset( &self, value: &str, ) -> Result<&Self, AeronCError>

pub fn timestamp_offset_reserved( &self, value: &str, ) -> Result<&Self, AeronCError>

pub fn response_correlation_id(&self, value: i64) -> Result<&Self, AeronCError>

pub fn nak_delay(&self, value: i64) -> Result<&Self, AeronCError>

pub fn untethered_window_limit_timeout( &self, value: i64, ) -> Result<&Self, AeronCError>

pub fn untethered_resting_timeout( &self, value: i64, ) -> Result<&Self, AeronCError>

pub fn max_resend(&self, value: i32) -> Result<&Self, AeronCError>

pub fn stream_id(&self, value: i32) -> Result<&Self, AeronCError>

pub fn publication_window(&self, value: i32) -> Result<&Self, AeronCError>

pub fn build_into(&self, dst: &mut String) -> Result<(), AeronCError>

pub fn remove(&self, key: &CStr) -> Result<i32, AeronCError>

Remove a key from the URI builder by setting it to null.

Example

let builder = AeronUriStringBuilder::default();
builder.remove(std::ffi::CStr::from_bytes_until_nul(b"tags\0").unwrap())?;

pub fn remove_str(&self, key: &str) -> Result<i32, AeronCError>

Remove a key from the URI builder by string slice.

Example

let builder = AeronUriStringBuilder::default();
builder.remove_str("tags")?;

Trait Implementations

impl Clone for AeronUriStringBuilder

fn clone(&self) -> AeronUriStringBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AeronUriStringBuilder

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

Formats the value using the given formatter.

impl Default for AeronUriStringBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Deref for AeronUriStringBuilder

type Target = aeron_uri_string_builder_stct

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<&AeronUriStringBuilder> for *mut aeron_uri_string_builder_t

fn from(value: &AeronUriStringBuilder) -> Self

Converts to this type from the input type.

impl From<*const aeron_uri_string_builder_stct> for AeronUriStringBuilder

fn from(value: *const aeron_uri_string_builder_t) -> Self

Converts to this type from the input type.

impl From<*mut aeron_uri_string_builder_stct> for AeronUriStringBuilder

fn from(value: *mut aeron_uri_string_builder_t) -> Self

Converts to this type from the input type.

impl From<AeronUriStringBuilder> for *mut aeron_uri_string_builder_t

fn from(value: AeronUriStringBuilder) -> Self

Converts to this type from the input type.

impl From<AeronUriStringBuilder> for aeron_uri_string_builder_t

fn from(value: AeronUriStringBuilder) -> Self

Converts to this type from the input type.

impl From<aeron_uri_string_builder_stct> for AeronUriStringBuilder

fn from(value: aeron_uri_string_builder_t) -> Self

Converts to this type from the input type.

impl FromStr for AeronUriStringBuilder

type Err = AeronCError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.