Skip to main content

AeronArchiveReplicationParamsOwned

Struct AeronArchiveReplicationParamsOwned 

Source
pub struct AeronArchiveReplicationParamsOwned { /* private fields */ }
Expand description

AeronArchiveReplicationParams plus the string storage its C struct points into.

The C params struct stores raw char * pointers, so the strings must outlive it, so this wrapper owns them. Deref gives the params for archive.replicate(...).

Methods from Deref<Target = AeronArchiveReplicationParams>§

Source

pub fn stop_position(&self) -> i64

Source

pub fn dst_recording_id(&self) -> i64

Source

pub fn live_destination(&self) -> &str

Source

pub fn replication_channel(&self) -> &str

Source

pub fn src_response_channel(&self) -> &str

Source

pub fn channel_tag_id(&self) -> i64

Source

pub fn subscription_tag_id(&self) -> i64

Source

pub fn file_io_max_length(&self) -> i32

Source

pub fn replication_session_id(&self) -> i32

Source

pub fn encoded_credentials(&self) -> Ref<'_, AeronArchiveEncodedCredentials>

Source

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

Initialize an AeronArchiveReplicationParams with the default values

Source

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

Source

pub unsafe fn get_inner_mut(&self) -> &mut aeron_archive_replication_params_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.

Source

pub fn get_inner_ref(&self) -> &aeron_archive_replication_params_t

Source

pub unsafe fn clone_struct(&self) -> Self

Copies the underlying struct into a new heap allocation

Only for plain data structs with no init or clean-up functions, so not for Aeron, AeronContext, AeronPublication or AeronSubscription

§Safety

Number fields are copied, but pointer fields (strings, buffers, other structs) still point at the source’s memory. Do not read them, including via Debug, once that memory is freed. For a callback argument that is when the callback returns. Copy strings out with .to_owned() instead

Trait Implementations§

Source§

impl Deref for AeronArchiveReplicationParamsOwned

Source§

type Target = AeronArchiveReplicationParams

The resulting type after dereferencing.
Source§

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

Dereferences the value.

Auto Trait Implementations§

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.

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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.