Skip to main content

LarkSpreadsheetLoader

Struct LarkSpreadsheetLoader 

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

Load rows from a Feishu/Lark spreadsheet as Synaptic Documents.

Each non-header row becomes one document. The column designated by [with_content_col] supplies the document content; all other columns are stored in the document metadata.

§Example

use synaptic_lark::{LarkConfig, LarkSpreadsheetLoader};
use synaptic_core::Loader;

let loader = LarkSpreadsheetLoader::new(LarkConfig::new("cli_xxx", "secret"))
    .with_token("shtcnXxx")
    .with_sheet("0")
    .with_content_col(0)
    .with_header_row(true);
let docs = loader.load().await?;

Implementations§

Source§

impl LarkSpreadsheetLoader

Source

pub fn new(config: LarkConfig) -> Self

Create a new loader using the given config.

Source

pub fn with_token(self, t: impl Into<String>) -> Self

Set the spreadsheet token (e.g. "shtcnXxx").

Source

pub fn with_sheet(self, id: impl Into<String>) -> Self

Set the sheet ID within the spreadsheet (default "0").

Source

pub fn with_content_col(self, col: usize) -> Self

Set which column (0-indexed) to use as document content (default 0).

Source

pub fn with_header_row(self, v: bool) -> Self

Whether the first row is a header row (default true).

Source

pub fn spreadsheet_token(&self) -> &str

Return the spreadsheet token (empty string if not set).

Source

pub fn sheet_id(&self) -> &str

Return the sheet ID.

Trait Implementations§

Source§

impl Loader for LarkSpreadsheetLoader

Source§

fn load<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, SynapticError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Load all documents from this source.
Source§

fn lazy_load( &self, ) -> Pin<Box<dyn Stream<Item = Result<Document, SynapticError>> + Send + '_>>

Stream documents lazily. Default implementation wraps load().

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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