Skip to main content

Doc

Enum Doc 

Source
pub enum Doc {
    Json(JsonAdapter),
    Csv(CsvAdapter),
    Xml(XmlAdapter),
    Html(HtmlAdapter),
    Sqlite(SqliteAdapter),
    Fs(FsAdapter),
    FsDeep(ComposeAdapter<FsAdapter>),
    Git(GitAdapter),
    Archive(ComposeAdapter<ArchiveAdapter>),
    Xlsx(XlsxAdapter),
    Code(CodeAdapter),
    Mount(MountAdapter),
}
Expand description

A materialized source: one variant per adapter family. JSON-model formats (json/yaml/toml) render node results as pointers, the rest as locators.

Variants§

Implementations§

Source§

impl Doc

Source

pub fn parse(input: &str, format: &str) -> Result<Doc>

Parse a text document by format name — the wasm entry point, and the text tail of the native open. Formats: json, yaml, toml, csv, tsv, xml, html, markdown, jsonl/ndjson.

Source

pub fn run( &self, query: &str, now: (i64, u32), allow_shell: bool, ) -> Result<QueryResult>

Run one query against this source with the session’s invocation instant and shell permission. The query text carries any macro definitions inline (the session prepends its table), which quarb::run expands.

Source

pub fn render(&self, node: NodeId) -> String

Render a node result as its source-appropriate locator.

Source§

impl Doc

Source

pub fn open(path: &Path, opts: &Options) -> Result<Doc>

Open one path as a local source. Directories are filesystem trees (--descend grafts parseable leaves); git:PATH opens a repository; binary kinds (SQLite, spreadsheets, archives) and source files dispatch by extension/magic; everything else is a text document parsed by extension or content sniff.

Source

pub fn mount(paths: &[PathBuf], opts: &Options) -> Result<Doc>

Open several sources as named children of one root (file stem = mount name), so a single query — including a <=> join — spans them all.

Auto Trait Implementations§

§

impl !Freeze for Doc

§

impl !RefUnwindSafe for Doc

§

impl !Send for Doc

§

impl !Sync for Doc

§

impl !UnwindSafe for Doc

§

impl Unpin for Doc

§

impl UnsafeUnpin for Doc

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.