Struct Group 

pub struct Group {
    pub id: Uuid,
    pub name: String,
    pub description: Option<String>,
}

Available on crate feature auth and non-WebAssembly only.

User group

When the database feature is enabled, this struct is also a database model mapped to the auth_group table.

Examples

use reinhardt_auth::group_management::Group;
use uuid::Uuid;

let group = Group {
    id: Uuid::new_v4(),
    name: "Editors".to_string(),
    description: Some("Content editors".to_string()),
};

assert_eq!(group.name, "Editors");

Fields

id: Uuid

Unique identifier for the group.

name: String

Name of the group.

description: Option<String>

Optional description of the group’s purpose.

Implementations

impl Group

pub fn new<S0>(name: S0, description: Option<String>) -> Group

where S0: Into<String>,

Create a new instance with user-specified fields.

Auto-generated fields are initialized automatically:

• UUID primary keys: Generated with Uuid::new_v4()
• Timestamp fields (created_at, updated_at, etc.): Set to Utc::now()
• Fields with #[field(auto_now_add)] or #[field(auto_now)]: Set to Utc::now()
• ManyToManyField: Initialized with Default::default()
• ForeignKeyField: Initialized with Default::default()
• Identity/AutoIncrement fields: Set to Default::default() (DB assigns value)

Foreign Key Parameters

Foreign key fields accept either:

• The related model instance (e.g., User { ... })
• A reference to the related model (e.g., &user)
• The primary key value directly (e.g., user_id: Uuid)

impl Group

pub fn id(&self) -> Uuid

Get id

pub fn name(&self) -> &String

Get reference to name

pub fn description(&self) -> &Option<String>

Get reference to description

impl Group

pub fn set_name(&mut self, value: String)

Set name

pub fn set_description(&mut self, value: Option<String>)

Set description

impl Group

pub const fn field_id() -> FieldRef<Group, Uuid>

Field accessor for type-safe field references

Returns a FieldRef<#struct_name, #field_type> that provides compile-time type safety for field operations.

pub const fn field_name() -> FieldRef<Group, String>

Field accessor for type-safe field references

Returns a FieldRef<#struct_name, #field_type> that provides compile-time type safety for field operations.

pub const fn field_description() -> FieldRef<Group, Option<String>>

Field accessor for type-safe field references

Returns a FieldRef<#struct_name, #field_type> that provides compile-time type safety for field operations.

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Group

fn deserialize<__D>( __deserializer: __D, ) -> Result<Group, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Model for Group

type PrimaryKey = Uuid

The primary key type

type Fields = GroupFields

Type-safe field selector

fn table_name() -> &'static str

Get the table name

fn new_fields() -> <Group as Model>::Fields

Create a new field selector instance

fn app_label() -> &'static str

Get the app label for this model

fn primary_key_field() -> &'static str

Get the primary key field name

fn primary_key(&self) -> Option<<Group as Model>::PrimaryKey>

Get the primary key value

fn set_primary_key(&mut self, value: <Group as Model>::PrimaryKey)

Set the primary key value

fn field_metadata() -> Vec<FieldInfo>

Get field metadata for inspection

fn index_metadata() -> Vec<IndexInfo>

Get index metadata for inspection

fn constraint_metadata() -> Vec<ConstraintInfo>

Get constraint metadata for inspection

fn relationship_metadata() -> Vec<RelationInfo>

Get relationship metadata for inspection

fn composite_primary_key() -> Option<CompositePrimaryKey>

Get composite primary key definition if this model uses composite PK

fn get_composite_pk_values(&self) -> HashMap<String, PkValue>

Get composite primary key values for this instance

fn objects() -> Manager<Self>

where Self: Sized,

Django-style objects manager accessor

fn save(&mut self) -> impl Future<Output = Result<(), Error>> + Send

where Self: Sized,

Save the model instance to the database with event dispatching

fn delete(&self) -> impl Future<Output = Result<(), Error>> + Send

where Self: Sized,

Delete the model instance from the database with event dispatching

impl PartialEq for Group

fn eq(&self, other: &Group) -> 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 Group

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Group

impl StructuralPartialEq for Group