Struct pravega_client::index::writer::IndexWriter

source ·
pub struct IndexWriter<T: Fields + PartialOrd + PartialEq + Debug> { /* private fields */ }
Expand description

Index Writer writes a fixed size Record to the stream.

Write takes a byte array as data and Fields. It hashes each Field name and construct a Record. Then it serializes the Record and writes to the stream.

§Examples

use pravega_client_config::ClientConfigBuilder;
use pravega_client::client_factory::ClientFactory;
use pravega_client_shared::ScopedStream;
use pravega_client_macros::Fields;
use std::io::Write;
use tokio;

#[derive(Fields, Debug, PartialOrd, PartialEq)]
struct MyFields {
    id: u64,
    timestamp: u64,
}

#[tokio::main]
async fn main() {
    // assuming Pravega controller is running at endpoint `localhost:9090`
    let config = ClientConfigBuilder::default()
        .controller_uri("localhost:9090")
        .build()
        .expect("creating config");

    let client_factory = ClientFactory::new(config);

    // assuming scope:myscope, stream:mystream exist.
    // notice that this stream should be a fixed sized single segment stream
    let stream = ScopedStream::from("myscope/mystream");

    let mut index_writer = client_factory.create_index_writer(stream).await;

    let fields = MyFields{id: 1, timestamp: 1000};
    let data = vec!{1; 10};

    index_writer.append(fields, data).await.expect("append data with fields");
    index_writer.flush().await.expect("flush");
}

Implementations§

source§

impl<T: Fields + PartialOrd + PartialEq + Debug> IndexWriter<T>

source

pub async fn append( &mut self, fields: T, data: Vec<u8> ) -> Result<(), IndexWriterError>

Append data with a given Fields.

source

pub async fn append_conditionally( &mut self, fields: T, condition_on: T, data: Vec<u8> ) -> Result<(), IndexWriterError>

Append data with a given Fields and conditioned on a Fields. The conditional Fields should match the latest Fields in the stream, if not, this method will fail with error.

source

pub async fn flush(&mut self) -> Result<(), IndexWriterError>

Flush data.

source

pub async fn truncate(&mut self, offset: u64) -> Result<(), IndexWriterError>

Truncate data to a given offset.

Auto Trait Implementations§

§

impl<T> !Freeze for IndexWriter<T>

§

impl<T> !RefUnwindSafe for IndexWriter<T>

§

impl<T> Send for IndexWriter<T>
where T: Send,

§

impl<T> Sync for IndexWriter<T>
where T: Sync,

§

impl<T> Unpin for IndexWriter<T>
where T: Unpin,

§

impl<T> !UnwindSafe for IndexWriter<T>

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

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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