Struct ReadOnlyModelViewSet 

pub struct ReadOnlyModelViewSet<M, S> { /* private fields */ }

Available on non-WebAssembly only.

ReadOnlyModelViewSet - only list and retrieve Demonstrates selective composition of mixins

Implementations

impl<M, S> ReadOnlyModelViewSet<M, S>

where M: 'static, S: 'static,

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

Creates a new ReadOnlyModelViewSet with the given basename.

Examples

use reinhardt_views::viewsets::{ReadOnlyModelViewSet, 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 = ReadOnlyModelViewSet::<User, reinhardt_rest::serializers::JsonSerializer<User>>::new("users");
assert_eq!(viewset.get_basename(), "users");

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

Set custom lookup field for this ViewSet

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

Set pagination configuration for this ViewSet

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

Disable pagination for this ViewSet

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

Set filter configuration for this ViewSet

Examples

use reinhardt_views::viewsets::{ReadOnlyModelViewSet, FilterConfig};

let viewset = ReadOnlyModelViewSet::<MyModel, MySerializer>::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) -> ReadOnlyModelViewSet<M, S>

Set ordering configuration for this ViewSet

Examples

use reinhardt_views::viewsets::{ReadOnlyModelViewSet, OrderingConfig};

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

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

where M: Send + Sync, S: Send + Sync,

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

Trait Implementations

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

where M: Send + Sync, S: Send + Sync,

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 ReadOnlyModelViewSet<M, S>

where M: Send + Sync, S: Send + Sync,

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 ReadOnlyModelViewSet<M, S>

where M: Send + Sync, S: Send + Sync,

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, ReadOnlyModelViewSet<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