Skip to main content

CollationMapper

Struct CollationMapper 

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

Maps user locales to database-specific collation strings.

The mapper takes a global CollationConfig and database type, then translates user locales (e.g., “fr-FR”) into the appropriate database-specific collation format (e.g., “fr-FR-x-icu” for PostgreSQL with ICU).

§Examples

use fraiseql_core::config::CollationConfig;
use fraiseql_core::db::{DatabaseType, collation::CollationMapper};

// PostgreSQL with ICU
let config = CollationConfig::default();
let mapper = CollationMapper::new(config.clone(), DatabaseType::PostgreSQL);
assert_eq!(mapper.map_locale("fr-FR").unwrap(), Some("fr-FR-x-icu".to_string()));

// MySQL (general collation, not locale-specific)
let mapper = CollationMapper::new(config, DatabaseType::MySQL);
assert_eq!(mapper.map_locale("fr-FR").unwrap(), Some("utf8mb4_unicode_ci".to_string()));

Implementations§

Source§

impl CollationMapper

Source

pub fn new(config: CollationConfig, database_type: DatabaseType) -> Self

Create a new collation mapper.

§Arguments
  • config - Global collation configuration
  • database_type - Target database type
Source

pub fn map_locale(&self, locale: &str) -> Result<Option<String>>

Map user locale to database-specific collation string.

§Arguments
  • locale - User locale (e.g., “fr-FR”, “ja-JP”)
§Returns
  • Ok(Some(collation)) - Database-specific collation string
  • Ok(None) - Use database default (no COLLATE clause)
  • Err(_) - Invalid locale when strategy is Error
§Errors

Returns FraiseQLError::Validation if locale is not in allowed list and on_invalid_locale is set to Error.

§Examples
use fraiseql_core::config::CollationConfig;
use fraiseql_core::db::{DatabaseType, collation::CollationMapper};

let config = CollationConfig::default();
let mapper = CollationMapper::new(config, DatabaseType::PostgreSQL);

// Valid locale
let collation = mapper.map_locale("fr-FR").unwrap();
assert_eq!(collation, Some("fr-FR-x-icu".to_string()));

// Invalid locale (not in allowed list)
let result = mapper.map_locale("invalid");
assert!(result.is_ok()); // Returns fallback by default
Source

pub const fn database_type(&self) -> DatabaseType

Get the database type this mapper is configured for.

Source

pub const fn is_enabled(&self) -> bool

Check if collation is enabled.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more