Struct Doc 

pub struct Doc {
    pub id: i64,
    pub project_id: i64,
    pub repo_id: Option<i64>,
    pub title: Option<String>,
    pub location: String,
    pub created_at: String,
}

A plan or design document a project’s work derives from (DESIGN.md §3), and the thing tasks link to so “which tasks came from this plan?” is a query rather than a grep over task bodies. Owned by one project — which is where a relative location resolves — but linkable from a task in any project, since one plan routinely spawns work across several.

Fields

id: i64

project_id: i64

repo_id: Option<i64>

Which of the project’s checkouts a relative location resolves against, or None for the project’s default — the same shape as Task::repo_id. Always None for a URL or an absolute path, which resolve unaided.

title: Option<String>

An operator-supplied label, or None to read as the location itself.

location: String

A checkout-relative path (preferred, so it survives a checkout move), an absolute path outside every checkout, or a URL.

created_at: String

Implementations

impl Doc

pub fn is_url(&self) -> bool

Whether the location addresses the network rather than a file. A URL is handed to a reader verbatim; a path is resolved against a checkout.

pub fn label(&self) -> &str

What a rendered row calls this doc: its title when it has one, else the location, which is then the only name it has.

Trait Implementations

impl Clone for Doc

fn clone(&self) -> Doc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Doc

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

Formats the value using the given formatter.

impl Eq for Doc

impl PartialEq for Doc

fn eq(&self, other: &Doc) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Doc