Struct ModelViewSetHandler 

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

Available on native only.

Django REST Framework-style ViewSet handler for models

Provides automatic CRUD operations with permission checks, filtering, pagination, and serialization for Model types.

Examples

let handler = ModelViewSetHandler::<User>::new();

Implementations

impl<T> ModelViewSetHandler<T>

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

pub fn new() -> ModelViewSetHandler<T>

Create a new ModelViewSetHandler

Examples

let handler = ModelViewSetHandler::<User>::new();

pub fn with_queryset(self, queryset: Vec<T>) -> ModelViewSetHandler<T>

Set the queryset (in-memory data) for this handler

Examples

let users = vec![
    User { id: Some(1), username: "alice".to_string() },
    User { id: Some(2), username: "bob".to_string() },
];
let handler = ModelViewSetHandler::<User>::new()
    .with_queryset(users);

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

Set the serializer class for this handler

Examples

let serializer = Arc::new(ModelSerializer::<User>::new());
let handler = ModelViewSetHandler::<User>::new()
    .with_serializer(serializer);

pub fn with_pool(self, pool: Arc<Pool<Any>>) -> ModelViewSetHandler<T>

Set the database connection pool for this handler

Examples

let pool = Arc::new(AnyPool::connect("postgres://localhost/mydb").await?);
let handler = ModelViewSetHandler::<User>::new()
    .with_pool(pool);

pub fn with_db_backend(self, db_backend: DbBackend) -> ModelViewSetHandler<T>

Set the database backend type for this handler

Examples

let handler = ModelViewSetHandler::<User>::new()
    .with_db_backend(DbBackend::Sqlite);

pub fn add_permission( self, permission: Arc<dyn Permission>, ) -> ModelViewSetHandler<T>

Add a permission class to this handler

Examples

let handler = ModelViewSetHandler::<User>::new()
    .add_permission(Arc::new(IsAuthenticated));

pub fn add_filter_backend( self, backend: Arc<dyn FilterBackend>, ) -> ModelViewSetHandler<T>

Add a filter backend to this handler

pub fn with_pagination( self, pagination: PaginatorImpl, ) -> ModelViewSetHandler<T>

Set the pagination class for this handler

pub async fn list(&self, request: &Request) -> Result<Response, ViewError>

List all objects with optional filtering and pagination

Examples

let handler = ModelViewSetHandler::<User>::new();
let request = Request::builder()
    .method(Method::GET)
    .uri("/users/")
    .version(Version::HTTP_11)
    .headers(HeaderMap::new())
    .body(Bytes::new())
    .build()?;
let response = handler.list(&request).await?;

pub async fn retrieve( &self, request: &Request, pk: Value, ) -> Result<Response, ViewError>

Retrieve a single object by primary key

Examples

let handler = ModelViewSetHandler::<User>::new();
let request = Request::builder()
    .method(Method::GET)
    .uri("/users/1/")
    .version(Version::HTTP_11)
    .headers(HeaderMap::new())
    .body(Bytes::new())
    .build()?;
let pk = serde_json::json!(1);
let response = handler.retrieve(&request, pk).await?;

pub async fn create(&self, request: &Request) -> Result<Response, ViewError>

Create a new object

Examples

let handler = ModelViewSetHandler::<User>::new();
let request = Request::builder()
    .method(Method::POST)
    .uri("/users/")
    .version(Version::HTTP_11)
    .headers(HeaderMap::new())
    .body(Bytes::from(r#"{"username":"alice"}"#))
    .build()?;
let response = handler.create(&request).await?;

pub async fn update( &self, request: &Request, pk: Value, ) -> Result<Response, ViewError>

Update an existing object

Examples

let handler = ModelViewSetHandler::<User>::new();
let request = Request::builder()
    .method(Method::PUT)
    .uri("/users/1/")
    .version(Version::HTTP_11)
    .headers(HeaderMap::new())
    .body(Bytes::from(r#"{"username":"alice_updated"}"#))
    .build()?;
let pk = serde_json::json!(1);
let response = handler.update(&request, pk).await?;

pub async fn destroy( &self, request: &Request, pk: Value, ) -> Result<Response, ViewError>

Delete an object

Examples

let handler = ModelViewSetHandler::<User>::new();
let request = Request::builder()
    .method(Method::DELETE)
    .uri("/users/1/")
    .version(Version::HTTP_11)
    .headers(HeaderMap::new())
    .body(Bytes::new())
    .build()?;
let pk = serde_json::json!(1);
let response = handler.destroy(&request, pk).await?;

Trait Implementations

impl<T> Default for ModelViewSetHandler<T>

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

fn default() -> ModelViewSetHandler<T>

Returns the “default value” for a type.