Skip to main content

AssembleOptions

Struct AssembleOptions 

Source
pub struct AssembleOptions<'a> {
    pub with_pyramid: bool,
    pub with_text_index: bool,
    pub text_index_scope: Option<&'a TextIndexScope>,
    pub type_override: Option<&'a str>,
    pub algo: PyramidAlgo,
    pub perms: PermSet,
    pub graph_layout: GraphLayout,
    pub pyramid_layout: PyramidLayout,
    pub label_index: bool,
    pub schema: bool,
}
Expand description

Everything an in-memory build decides besides its input. The fields the older assemble_* entry points take positionally, plus the sections added after the generation-1 freeze.

Fields§

§with_pyramid: bool

Build the community pyramid (kind 4).

§with_text_index: bool

Build the full-text index (kind 6, or kind 11 when its scope leaves out some predicates).

§text_index_scope: Option<&'a TextIndexScope>

The scope of that index (--text-index-graphs, --text-index-include, --text-index-exclude); None is the default scope, the only one before 0.4.0: the default graph, every predicate.

§type_override: Option<&'a str>

The type predicate for the schema (e.g. wdt:P31); rdf:type if None.

§algo: PyramidAlgo

The community algorithm of the pyramid.

§perms: PermSet

Which index permutations to write.

§graph_layout: GraphLayout

How the named graphs are stored: one index per graph (kind 5) or the quad index (kind 10, rete build --named-graphs quad).

§pyramid_layout: PyramidLayout

What the pyramid-meta carries besides the summary.

§label_index: bool

Write the LABEL_INDEX section (kind 8, rete build --label-index).

§schema: bool

Write the SCHEMA section (kind 9; rete build writes it unless --no-schema).

Implementations§

Source§

impl AssembleOptions<'_>

Source

pub fn legacy() -> AssembleOptions<'_>

What every assemble_* entry point wrote before kinds 8 and 9 existed: a Louvain pyramid with the combined pyramid-meta, no text index, all six permutations, one index per named graph, no LABEL_INDEX or SCHEMA section.

Source

pub fn sectioned() -> AssembleOptions<'_>

What rete build writes: the pyramid-meta carries only the community material, the schema has its own section, and the label index is opt-in.

Trait Implementations§

Source§

impl<'a> Clone for AssembleOptions<'a>

Source§

fn clone(&self) -> AssembleOptions<'a>

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<'a> Copy for AssembleOptions<'a>

Source§

impl<'a> Debug for AssembleOptions<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for AssembleOptions<'a>

§

impl<'a> RefUnwindSafe for AssembleOptions<'a>

§

impl<'a> Send for AssembleOptions<'a>

§

impl<'a> Sync for AssembleOptions<'a>

§

impl<'a> Unpin for AssembleOptions<'a>

§

impl<'a> UnsafeUnpin for AssembleOptions<'a>

§

impl<'a> UnwindSafe for AssembleOptions<'a>

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

Source§

fn vzip(self) -> V