Struct cortex::models::Corpus

pub struct Corpus {
    pub id: i32,
    pub path: String,
    pub name: String,
    pub complex: bool,
    pub description: String,
}

A minimal description of a document collection. Defined by a name, path and simple/complex file system setup.

Fields

id: i32

auto-incremented postgres id

path: String

file system path to corpus root (a corpus is held in a single top-level directory)

name: String

a human-readable name for this corpus

complex: bool

are we using multiple files to represent a document entry? (if unsure, always use "true")

description: String

a human-readable description of the corpus, maybe allow markdown here?

Implementations

impl Corpus

pub fn find_by_name(
    name_query: &str,
    connection: &PgConnection
) -> Result<Self, Error>

ORM-like until diesel.rs introduces finders for more fields

pub fn find_by_path(
    path_query: &str,
    connection: &PgConnection
) -> Result<Self, Error>

ORM-like until diesel.rs introduces finders for more fields

pub fn to_hash(&self) -> HashMap<String, String>

Return a hash representation of the corpus, usually for frontend reports

pub fn select_services(
    &self,
    connection: &PgConnection
) -> Result<Vec<Service>, Error>

Return a vector of services currently activated on this corpus

pub fn destroy(self, connection: &PgConnection) -> Result<usize, Error>

Deletes a corpus and its dependent tasks from the DB, consuming the object

Trait Implementations

impl<'update> AsChangeset for &'update Corpus

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<path, &'update String>, Eq<name, &'update String>, Eq<complex, &'update bool>, Eq<description, &'update String>) as AsChangeset>::Changeset

The update statement this type represents

fn as_changeset(self) -> Self::Changeset

Convert self into the actual update statement being executed

impl<'update> AsChangeset for Corpus

type Target = table

The table which Self::Changeset will be updating

type Changeset = <(Eq<path, String>, Eq<name, String>, Eq<complex, bool>, Eq<description, String>) as AsChangeset>::Changeset

The update statement this type represents

fn as_changeset(self) -> Self::Changeset

Convert self into the actual update statement being executed

impl Clone for Corpus

fn clone(&self) -> Corpus

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Corpus

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl HasTable for Corpus

type Table = table

The table this type is associated with.

fn table() -> Self::Table

Returns the table this type is associated with.

impl<'ident> Identifiable for &'ident Corpus

type Id = &'ident i32

The type of this struct's identifier.

fn id(self) -> Self::Id

Returns the identifier for this record.

impl<__DB: Backend, __ST> Queryable<__ST, __DB> for Corpus where
    (i32, String, String, bool, String): Queryable<__ST, __DB>, 

type Row = <(i32, String, String, bool, String) as Queryable<__ST, __DB>>::Row

The Rust type you'd like to map from.

fn build(row: Self::Row) -> Self

Construct an instance of this type

impl Serialize for Corpus

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.