Skip to main content

Namespace

Enum Namespace 

Source
pub enum Namespace {
    Neo4j,
    System,
    SystemOntologies,
}
Expand description

One of the three fixed namespaces of a store.

Element ids name their namespace through the middle segment of <kind>:<segment>:<n|r><id> (ADR-0116 §7, ADR-0554): the segment is dash-bearing and names the database — rl-id for neo4j, rl-onto for system_ontologies — and system has no elements and no segment.

Variants§

§

Neo4j

The user data graph. The only namespace Cypher can write.

§

System

The CE system database: SHOW commands, supported administration commands and procedure calls only. Holds no graph data.

§

SystemOntologies

The read-only ontology graph, written only through the db.ontology.* procedures. Its dialect visibility gates behind the ontology preview feature (ADR-0593): invisible — unlisted, unaddressable — while the opt-in is off.

Implementations§

Source§

impl Namespace

Source

pub const ALL: [Namespace; 3]

Every namespace, in canonical order: neo4j, system, system_ontologies.

Source

pub fn as_str(&self) -> &'static str

The canonical (lowercase) namespace name.

Source

pub fn parse(name: &str) -> Option<Namespace>

Parses a namespace name, case-insensitively (ADR-0116 §1). Returns None for any other name.

Source

pub fn is_writable(&self) -> bool

Whether Cypher can write this namespace. Only neo4j is writable (ADR-0116 §5: read many, write one).

Source

pub fn is_read_only(&self) -> bool

Whether this namespace is read-only to Cypher. Only system_ontologies is (ADR-0116 §1).

Source

pub fn visible_under(self, preview: PreviewFeatures) -> bool

Whether this namespace is visible under preview (ADR-0593): a namespace gated by [namespace_preview_feature] stays invisible until its feature’s opt-in is set; the ungated namespaces are always visible. The one predicate every visibility consumer derives from — the SHOW DATABASES listing, USE and connect resolution, ALTER DATABASE targets.

Source

pub fn require_visible(self, preview: PreviewFeatures) -> Result<(), Error>

The visibility gate (ADR-0593): Ok(()) when Self::visible_under holds, otherwise the ordinary unknown-database rejection (42N00, ce_messages::graph_not_found) — the name-gate form ADR-0371 prescribes for hidden names: never the authored preview error, which would advertise a name the catalog must not list.

Source

pub fn element_id_segment(&self) -> Option<&'static str>

The element-id middle segment for this namespace (ADR-0116 §7, ADR-0554), or None for system, which has no elements. The segment is dash-bearing and names the database, as Neo4j’s UUID segment does — clients classify an id as an element id by that observable dash (ADR-0554’s Context).

Source

pub fn from_element_id_segment(segment: &str) -> Option<Namespace>

The inverse of Namespace::element_id_segment: maps an element-id middle segment back to its namespace. Returns None for any other segment (including system, which has none).

Trait Implementations§

Source§

impl Clone for Namespace

Source§

fn clone(&self) -> Self

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 Copy for Namespace

Source§

impl Debug for Namespace

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for Namespace

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Namespace

Source§

impl FromStr for Namespace

Source§

type Err = ()

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Namespace

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Namespace

Source§

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for Namespace

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for Namespace

Source§

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl StructuralPartialEq for Namespace

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> 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> 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<Q, K> Comparable<K> for Q
where Q: Ord + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn compare(&self, key: &K) -> Ordering

Compare self to key and return their ordering.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.