Skip to main content

EncoderCodec

Struct EncoderCodec 

Source
pub struct EncoderCodec<E> { /* private fields */ }
Expand description

A Codec adapter that wraps any EventEncoder.

EncoderCodec calls EventEncoder::encode_key for the key and EventEncoder::encode for the value. It is the canonical bridge between the lower-level EventEncoder trait and the higher-level Codec trait.

§Example

use rustcdc::codec::{Codec, EncoderCodec, JsonEncoder};
use rustcdc::{Event, Operation, EVENT_ENVELOPE_VERSION};
use serde_json::json;

let codec = EncoderCodec::new(JsonEncoder);
let event = Event {
    after: Some(json!({"id": 1})),
    op: Operation::Insert,
    primary_key: Some(vec!["id".into()]),
    ..Event::default()
};
let out = codec.encode(&event).unwrap();
assert_eq!(out.content_type, "application/json");
assert!(out.key.is_some());

Implementations§

Source§

impl<E: EventEncoder> EncoderCodec<E>

Source

pub fn new(encoder: E) -> Self

Wrap an EventEncoder as a Codec.

Source

pub fn encoder(&self) -> &E

Borrow the inner encoder.

Source

pub fn into_encoder(self) -> E

Unwrap the inner encoder.

Trait Implementations§

Source§

impl<E: Clone> Clone for EncoderCodec<E>

Source§

fn clone(&self) -> EncoderCodec<E>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<E: EventEncoder> Codec for EncoderCodec<E>

Source§

fn encode(&self, event: &Event) -> Result<CodecOutput>

Encode the event into a key + value pair.
Source§

fn content_type(&self) -> &'static str

The MIME content type for every successful value byte sequence.
Source§

fn boxed(self) -> BoxedCodec
where Self: Sized + 'static,

Wrap self in a BoxedCodec, erasing the concrete type. Read more
Source§

impl<E: Debug> Debug for EncoderCodec<E>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<E: Default> Default for EncoderCodec<E>

Source§

fn default() -> EncoderCodec<E>

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<E> Freeze for EncoderCodec<E>
where E: Freeze,

§

impl<E> RefUnwindSafe for EncoderCodec<E>
where E: RefUnwindSafe,

§

impl<E> Send for EncoderCodec<E>
where E: Send,

§

impl<E> Sync for EncoderCodec<E>
where E: Sync,

§

impl<E> Unpin for EncoderCodec<E>
where E: Unpin,

§

impl<E> UnsafeUnpin for EncoderCodec<E>
where E: UnsafeUnpin,

§

impl<E> UnwindSafe for EncoderCodec<E>
where E: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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