Skip to main content

JsSchema

Struct JsSchema 

Source
pub struct JsSchema { /* private fields */ }
Expand description

Dictionary schema definition.

Defines the structure and fields of dictionary entries.

Implementations§

Source§

impl JsSchema

Source

pub fn new(fields: Vec<String>) -> Self

Creates a new schema with the specified field names.

§Arguments
  • fields - Array of field name strings.
Source

pub fn create_default() -> Self

Creates a default schema matching the IPADIC format (13 fields).

§Returns

A schema with the standard IPADIC field definitions.

Source

pub fn fields(&self) -> Vec<String>

Returns the field names in the schema.

Source

pub fn get_field_index(&self, field_name: String) -> Option<u32>

Returns the index of the specified field name.

§Arguments
  • field_name - Name of the field to look up.
§Returns

The zero-based index of the field, or undefined if not found.

Source

pub fn field_count(&self) -> u32

Returns the total number of fields in the schema.

Source

pub fn get_field_name(&self, index: u32) -> Option<String>

Returns the field name at the specified index.

§Arguments
  • index - Zero-based index.
§Returns

The field name, or undefined if the index is out of range.

Source

pub fn get_custom_fields(&self) -> Vec<String>

Returns the custom fields (index 4 and above).

§Returns

An array of custom field names.

Source

pub fn get_all_fields(&self) -> Vec<String>

Returns all field names in the schema.

§Returns

An array of all field names.

Source

pub fn get_field_by_name(&self, name: String) -> Option<JsFieldDefinition>

Returns the field definition for the specified field name.

§Arguments
  • name - Name of the field to look up.
§Returns

The field definition, or undefined if not found.

Source

pub fn validate_record(&self, record: Vec<String>) -> Result<()>

Validates that a CSV record matches the schema.

§Arguments
  • record - Array of field values to validate.

Trait Implementations§

Source§

impl From<JsSchema> for Schema

Source§

fn from(schema: JsSchema) -> Self

Converts to this type from the input type.
Source§

impl From<Schema> for JsSchema

Source§

fn from(schema: Schema) -> Self

Converts to this type from the input type.
Source§

impl FromNapiMutRef for JsSchema

Source§

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

Safety Read more
Source§

impl FromNapiRef for JsSchema

Source§

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

Safety Read more
Source§

impl JavaScriptClassExt for JsSchema

Source§

fn into_instance<'scope>( self, env: &'scope Env, ) -> Result<ClassInstance<'scope, Self>>

Source§

fn into_reference(self, env: Env) -> Result<Reference<Self>>

Source§

fn instance_of<'env, V: JsValue<'env>>(env: &Env, value: &V) -> Result<bool>

Source§

impl ObjectFinalize for JsSchema

Source§

fn finalize(self, env: Env) -> Result<(), Error>

Source§

impl ToNapiValue for JsSchema

Source§

impl TypeName for &JsSchema

Source§

impl TypeName for &mut JsSchema

Source§

impl TypeName for JsSchema

Source§

impl ValidateNapiValue for &JsSchema

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more
Source§

impl ValidateNapiValue for &mut JsSchema

Source§

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

Safety Read more

Auto Trait Implementations§

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

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<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> JsValuesTupleIntoVec for T
where T: ToNapiValue,

Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> SendAlias for T

Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,

Source§

impl<T> SyncAlias for T