Struct ModelViewSet 

pub struct ModelViewSet<M, S>
where
    M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static,
    S: Send + Sync + 'static,
{ /* private fields */ }

Available on native only.

ModelViewSet - combines all CRUD mixins, backed by a real ModelViewSetHandler for database-backed CRUD.

Similar to Django REST Framework’s ModelViewSet but built around Rust type composition. dispatch() routes the standard REST verbs to the embedded handler’s list / retrieve / create / update / destroy methods, so registering a ModelViewSet with a router yields actual model-backed responses (not placeholders).

Implementations

impl<M, S> ModelViewSet<M, S>

where M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static, S: Send + Sync + 'static,

pub fn new(basename: impl Into<String>) -> ModelViewSet<M, S>

Creates a new ModelViewSet with the given basename.

Examples

use reinhardt_views::viewsets::{ModelViewSet, ViewSet};
use reinhardt_db::prelude::Model;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Clone, Debug)]
struct User {
    id: Option<i64>,
    username: String,
}

#[derive(Clone)]
struct UserFields;

impl reinhardt_db::orm::FieldSelector for UserFields {
    fn with_alias(self, _alias: &str) -> Self { self }
}

impl Model for User {
    type PrimaryKey = i64;
    type Fields = UserFields;
    fn table_name() -> &'static str { "users" }
    fn primary_key(&self) -> Option<Self::PrimaryKey> { self.id }
    fn set_primary_key(&mut self, value: Self::PrimaryKey) { self.id = Some(value); }
    fn new_fields() -> Self::Fields { UserFields }
}

let viewset = ModelViewSet::<User, reinhardt_rest::serializers::JsonSerializer<User>>::new("users");
assert_eq!(viewset.get_basename(), "users");

pub fn with_lookup_field(self, field: impl Into<String>) -> ModelViewSet<M, S>

Set custom lookup field for this ViewSet

Examples

use reinhardt_views::viewsets::{ModelViewSet, ViewSet};
use reinhardt_db::prelude::Model;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize, Clone, Debug)]
struct User {
    id: Option<i64>,
    username: String,
}

#[derive(Clone)]
struct UserFields;

impl reinhardt_db::orm::FieldSelector for UserFields {
    fn with_alias(self, _alias: &str) -> Self { self }
}

impl Model for User {
    type PrimaryKey = i64;
    type Fields = UserFields;
    fn table_name() -> &'static str { "users" }
    fn primary_key(&self) -> Option<Self::PrimaryKey> { self.id }
    fn set_primary_key(&mut self, value: Self::PrimaryKey) { self.id = Some(value); }
    fn new_fields() -> Self::Fields { UserFields }
}

let viewset = ModelViewSet::<User, ()>::new("users")
    .with_lookup_field("username");
assert_eq!(viewset.get_lookup_field(), "username");

pub fn with_pagination(self, config: PaginationConfig) -> ModelViewSet<M, S>

Set pagination configuration for this ViewSet

Examples

// Page number pagination with custom page size
let viewset = ModelViewSet::<Item, ()>::new("items")
    .with_pagination(PaginationConfig::page_number(20, Some(100)));

// Limit/offset pagination
let viewset = ModelViewSet::<Item, ()>::new("items")
    .with_pagination(PaginationConfig::limit_offset(25, Some(500)));

// Disable pagination
let viewset = ModelViewSet::<Item, ()>::new("items")
    .with_pagination(PaginationConfig::none());

pub fn without_pagination(self) -> ModelViewSet<M, S>

Disable pagination for this ViewSet

Examples

let viewset = ModelViewSet::<Item, ()>::new("items")
    .without_pagination();

pub fn with_filters(self, config: FilterConfig) -> ModelViewSet<M, S>

Set filter configuration for this ViewSet

Examples

let viewset = ModelViewSet::<Item, ()>::new("items")
    .with_filters(
        FilterConfig::new()
            .with_filterable_fields(vec!["status", "category"])
            .with_search_fields(vec!["title", "description"])
    );

pub fn with_ordering(self, config: OrderingConfig) -> ModelViewSet<M, S>

Set ordering configuration for this ViewSet

Examples

let viewset = ModelViewSet::<Item, ()>::new("items")
    .with_ordering(
        OrderingConfig::new()
            .with_ordering_fields(vec!["created_at", "title", "id"])
            .with_default_ordering(vec!["-created_at"])
    );

pub fn with_pool(self, pool: Arc<Pool<Any>>) -> ModelViewSet<M, S>

Set the database connection pool used by CRUD handlers.

Without a pool, list/retrieve fall back to the in-memory queryset (if any), and create/update/destroy will operate only on the queryset.

pub fn with_db_backend(self, backend: DbBackend) -> ModelViewSet<M, S>

Set the database backend type (PostgreSQL, MySQL, SQLite).

pub fn with_serializer( self, serializer: Arc<dyn Serializer<Output = String, Input = M> + Send + Sync>, ) -> ModelViewSet<M, S>

Set a custom serializer used by CRUD handlers.

pub fn with_queryset(self, items: Vec<M>) -> ModelViewSet<M, S>

Provide an in-memory queryset used when no database pool is set.

pub fn add_permission( self, permission: Arc<dyn Permission>, ) -> ModelViewSet<M, S>

Add a permission class enforced before each request.

pub fn add_filter_backend( self, backend: Arc<dyn FilterBackend>, ) -> ModelViewSet<M, S>

Add a filter backend applied to list requests.

pub fn as_view(self) -> ViewSetBuilder<ModelViewSet<M, S>>

Convert ViewSet to Handler with action mapping Returns a ViewSetBuilder for configuration

Trait Implementations

impl<M, S> FilterableViewSet for ModelViewSet<M, S>

where M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static, S: Send + Sync + 'static,

fn get_filter_config(&self) -> Option<FilterConfig>

Get filter configuration for this ViewSet

fn get_ordering_config(&self) -> Option<OrderingConfig>

Get ordering configuration for this ViewSet

fn extract_filters(&self, request: &Request) -> HashMap<String, String>

Extract filter parameters from request

fn extract_search(&self, request: &Request) -> Option<String>

Extract search parameter from request

fn extract_ordering(&self, request: &Request) -> Vec<String>

Extract ordering from request

impl<M, S> PaginatedViewSet for ModelViewSet<M, S>

where M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static, S: Send + Sync + 'static,

fn get_pagination_config(&self) -> Option<PaginationConfig>

Get pagination configuration for this ViewSet

fn paginate_queryset<'life0, 'life1, 'async_trait, T>( &'life0 self, items: Vec<T>, request: &'life1 Request, ) -> Pin<Box<dyn Future<Output = Result<PaginatedResponse<T>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, T: 'async_trait + Serialize + Clone + Send + Sync, Self: 'async_trait,

Paginate a list of items based on the request and configuration

impl<M, S> ViewSet for ModelViewSet<M, S>

where M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static, S: Send + Sync + 'static,

fn get_basename(&self) -> &str

Get the basename for URL routing

fn get_lookup_field(&self) -> &str

Get the lookup field for detail routes Defaults to “id” if not overridden

fn dispatch<'life0, 'async_trait>( &'life0 self, request: Request, action: Action, ) -> Pin<Box<dyn Future<Output = Result<Response, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, ModelViewSet<M, S>: 'async_trait,

Dispatch request to appropriate action

fn get_extra_actions(&self) -> Vec<ActionMetadata>

Dispatch request with dependency injection context

fn get_extra_action_url_map(&self) -> HashMap<String, String>

Get URL map for extra actions Returns empty map for uninitialized ViewSets

fn get_current_base_url(&self) -> Option<String>

Get current base URL (only available after initialization)

fn reverse_action( &self, _action_name: &str, _args: &[&str], ) -> Result<String, Error>

Reverse an action name to a URL

fn get_middleware(&self) -> Option<Arc<dyn ViewSetMiddleware>>

Get middleware for this ViewSet Returns None if no middleware is configured

fn requires_login(&self) -> bool

Check if login is required for this ViewSet

fn get_required_permissions(&self) -> Vec<String>

Get required permissions for this ViewSet

impl<M, S> RefUnwindSafe for ModelViewSet<M, S>

where M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static, S: Send + Sync + 'static,

impl<M, S> UnwindSafe for ModelViewSet<M, S>

where M: Model + Serialize + DeserializeOwned + Clone + Send + Sync + 'static, S: Send + Sync + 'static,