Struct PositionInDocument

pub struct PositionInDocument {
    pub document_id: DocumentId,
    pub page_number: String,
    pub index: i64,
    pub geometry: Option<Geometry>,
}

The reference position within a document of one specific form

Fields

document_id: DocumentId

What document is this item within?

page_number: String

What page is it on (starting from 1)? May be a single page or range of pages.

index: i64

How many items come before this one in the whole document?

1-indexed position indicating where the form sits in the ordering of all forms in the document. Used for relative ordering of forms from the same document.

geometry: Option<Geometry>

What section of the document image corresponds to this item?

Implementations

impl PositionInDocument

pub async fn document_id(&self, ctx: &Context<'_>) -> Result<&DocumentId>

pub async fn page_number(&self, ctx: &Context<'_>) -> Result<&String>

pub async fn index(&self, ctx: &Context<'_>) -> Result<&i64>

pub async fn geometry(&self, ctx: &Context<'_>) -> Result<&Option<Geometry>>

impl PositionInDocument

pub fn new(document_id: DocumentId, page_number: String, index: i64) -> Self

Make a new document position from the document ID, page number, and item index.

pub fn make_id(&self, gloss: &str, use_index: bool) -> String

Make a unique ID to identify a string at this position, clearing all non-ASCII characters from the given string.

pub fn make_raw_id(&self, raw_gloss: &str, use_index: bool) -> String

Converts the input into a suitable ID format by stripping whitespace and punctuation before putting the document ID before it.

pub fn make_form_id(&self, segments: &[WordSegment]) -> String

Create a rough URI-like string for this word with the given morphemic segmentation.

Trait Implementations

impl Clone for PositionInDocument

fn clone(&self) -> PositionInDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ContainerType for PositionInDocument

fn resolve_field<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, ctx: &'life1 Context<'life2>, ) -> Pin<Box<dyn Future<Output = ServerResult<Option<Value>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Resolves a field value and outputs it as a json value async_graphql::Value.

fn collect_all_fields<'a>( &'a self, ctx: &ContextBase<'a, &'a Positioned<SelectionSet>>, fields: &mut Fields<'a>, ) -> Result<(), ServerError>

where Self: Send + Sync,

Collect all the fields of the container that are queried in the selection set.

fn find_entity<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _: &'life1 ContextBase<'life2, &'life2 Positioned<Field>>, _params: &'life3 ConstValue, ) -> Pin<Box<dyn Future<Output = Result<Option<ConstValue>, ServerError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, Self: Sync + 'async_trait,

Find the GraphQL entity with the given name from the parameter.

impl Debug for PositionInDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PositionInDocument

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OutputType for PositionInDocument

fn type_name() -> Cow<'static, str>

Type the name.

fn create_type_info(registry: &mut Registry) -> String

Create type information in the registry and return qualified typename.

fn resolve<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, ctx: &'life1 ContextSelectionSet<'life2>, _field: &'life3 Positioned<Field>, ) -> Pin<Box<dyn Future<Output = ServerResult<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Resolve an output value to async_graphql::Value.

fn qualified_type_name() -> String

Qualified typename.

fn introspection_type_name(&self) -> Cow<'static, str>

Introspection type name

impl PartialEq for PositionInDocument

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PositionInDocument

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ObjectType for PositionInDocument

impl StructuralPartialEq for PositionInDocument