backbone-bucket 0.3.1

Bucket Bounded Context: File Storage Module for Backbone Framework
Documentation
//! Repository trait for FileLock aggregate
//!
//! Generated by metaphor-schema. Do not edit manually.
//!
//! This trait defines the repository contract for the FileLock aggregate.
//! Implementation is in the infrastructure layer.

use async_trait::async_trait;
use anyhow::Result;
use uuid::Uuid;

use crate::domain::entity::{FileLock, LockStatus};

/// Pagination parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct FileLockPaginationParams {
    pub page: u32,
    pub per_page: u32,
}

impl FileLockPaginationParams {
    pub fn new(page: u32, per_page: u32) -> Self {
        Self { page, per_page }
    }

    pub fn offset(&self) -> u64 {
        ((self.page.saturating_sub(1)) * self.per_page) as u64
    }

    pub fn limit(&self) -> u64 {
        self.per_page as u64
    }
}

/// Paginated result for list queries
#[derive(Debug, Clone)]
pub struct FileLockPaginatedResult {
    pub data: Vec<FileLock>,
    pub total: u64,
    pub page: u32,
    pub per_page: u32,
}

/// Filter parameters for list queries
#[derive(Debug, Clone, Default)]
pub struct FileLockFilter {
    pub file_id: Option<Uuid>,
    pub user_id: Option<Uuid>,
    pub status: Option<LockStatus>,
}

impl FileLockFilter {
    /// Check if any filter is set
    pub fn has_filters(&self) -> bool {
        self.file_id.is_some() || self.user_id.is_some() || self.status.is_some()
    }
}

/// Repository trait for FileLock aggregate
///
/// This trait defines the persistence contract for FileLock entities.
/// Implementations should be in the infrastructure layer.
#[async_trait]
pub trait FileLockRepository: Send + Sync {

    // =========================================================================
    // Core CRUD Operations
    // =========================================================================

    /// Save a new file_lock entity
    async fn save(&self, entity: &FileLock) -> Result<FileLock>;

    /// Find file_lock by ID
    async fn find_by_id(&self, id: &str) -> Result<Option<FileLock>>;

    /// Find all file_lock entities
    async fn find_all(&self) -> Result<Vec<FileLock>>;

    /// Update file_lock by ID
    async fn update(&self, id: &str, entity: &FileLock) -> Result<Option<FileLock>>;

    /// Delete file_lock by ID
    async fn delete(&self, id: &str) -> Result<bool>;

    // =========================================================================
    // Pagination
    // =========================================================================

    /// List file_lock with pagination
    async fn list(&self, params: FileLockPaginationParams) -> Result<FileLockPaginatedResult>;

    /// List file_lock with pagination and filters
    async fn list_with_filters(&self, params: FileLockPaginationParams, filters: FileLockFilter) -> Result<FileLockPaginatedResult>;

    /// Count all file_lock entities
    async fn count(&self) -> Result<u64>;

    /// Count file_lock entities matching filters
    async fn count_with_filters(&self, filters: FileLockFilter) -> Result<u64>;

    /// Check if file_lock exists by ID
    async fn exists(&self, id: &str) -> Result<bool>;

    // =========================================================================
    // Soft Delete Operations
    // =========================================================================

    /// Soft delete file_lock by ID
    async fn soft_delete(&self, id: &str) -> Result<bool>;

    /// Restore soft-deleted file_lock by ID
    async fn restore(&self, id: &str) -> Result<Option<FileLock>>;

    /// List soft-deleted file_lock entities
    async fn list_deleted(&self, params: FileLockPaginationParams) -> Result<FileLockPaginatedResult>;

    /// Empty trash (permanently delete all soft-deleted entities)
    async fn empty_trash(&self) -> Result<u64>;

    // =========================================================================
    // Query by Unique Fields
    // =========================================================================

    /// Find file_lock by file_id
    async fn find_by_file_id(&self, file_id: Uuid) -> Result<Option<FileLock>>;

    // =========================================================================
    // Existence Checks by Unique Fields
    // =========================================================================

    /// Check if file_lock exists by file_id
    async fn exists_by_file_id(&self, file_id: Uuid) -> Result<bool>;

    // =========================================================================
    // Bulk Operations
    // =========================================================================

    /// Bulk save file_lock entities
    async fn bulk_save(&self, entities: &[FileLock]) -> Result<Vec<FileLock>>;

    /// Bulk delete by IDs
    async fn bulk_delete(&self, ids: &[&str]) -> Result<u64>;
}