Skip to main content

ReadWords

sql_cli::sql::generators::file_readers

Struct ReadWords

pub struct ReadWords;

Expand description

READ_WORDS(path [, min_length [, case]]) - Read a text file and emit one row per word.

Emits (word_num, word, line_num, word_pos) rows where:

word_num is a global 1-based word counter across the whole file
word is the extracted token (punctuation stripped)
line_num is the original 1-based line number the word came from
word_pos is the 1-based position of the word within its line

Optional min_length (default 1) filters out short words. Optional case (‘lower’ or ‘upper’) normalises word casing.

Trait Implementations§

impl TableGenerator for ReadWords

fn name(&self) -> &str

Get the name of the generator function (e.g., “GENERATE_PRIMES”)

fn columns(&self) -> Vec<DataColumn>

Get the column definitions for the generated table

fn generate(&self, args: Vec<DataValue>) -> Result<Arc<DataTable>>

Generate the table based on the provided arguments Arguments are evaluated expressions from the SQL query

fn description(&self) -> &str

Get a description of what this generator does

fn arg_count(&self) -> usize

Get the expected number of arguments

Auto Trait Implementations§

impl Freeze for ReadWords

impl RefUnwindSafe for ReadWords

impl Send for ReadWords

impl Sync for ReadWords

impl Unpin for ReadWords

impl UnsafeUnpin for ReadWords

impl UnwindSafe for ReadWords

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Same for T

type Output = T

Should always be Self

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

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

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.

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