Specification

Struct Specification 

Source
pub struct Specification {
    pub id: String,
    pub name: String,
    pub description: String,
    pub status: SpecStatus,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
    pub content: String,
}
Expand description

Represents a project specification with detailed requirements and implementation details.

A Specification captures the detailed requirements, design decisions, and implementation plans for a specific feature or component of a project. Specifications are stored as structured documents with markdown content and are tracked through various status states.

§ID Format

Specification IDs follow the format YYYYMMDD_snake_case_name where:

  • YYYYMMDD is the creation date (e.g., “20240115”)
  • snake_case_name describes the specification (e.g., “user_authentication”)
  • Example: “20240115_user_authentication”

§Fields

  • id - Unique identifier in YYYYMMDD_name format
  • name - Human-readable title for the specification
  • description - Brief summary of what the specification covers
  • status - Current progress state (Draft, InProgress, Completed, OnHold)
  • created_at - Timestamp when the specification was created
  • updated_at - Timestamp of the last modification
  • content - Full specification content in Markdown format

§Examples

use project_manager_mcp::models::specification::{Specification, SpecStatus};
use chrono::Utc;

// Create a new API specification
let api_spec = Specification {
    id: "20240115_rest_api".to_string(),
    name: "REST API Design".to_string(),
    description: "RESTful API endpoints for user management".to_string(),
    status: SpecStatus::Draft,
    created_at: Utc::now(),
    updated_at: Utc::now(),
    content: "# REST API Specification\n\n## Overview\nThis specification defines the REST API endpoints for user management.\n\n## Endpoints\n\n### GET /users\n- Returns list of all users\n- Supports pagination via query parameters\n\n### POST /users\n- Creates a new user\n- Requires JSON body with user data\n\n## Authentication\nAll endpoints require JWT token in Authorization header.".to_string(),
};

// Create a database schema specification
let db_spec = Specification {
    id: "20240116_database_schema".to_string(),
    name: "Database Schema Design".to_string(),
    description: "PostgreSQL schema for user and product data".to_string(),
    status: SpecStatus::InProgress,
    created_at: Utc::now(),
    updated_at: Utc::now(),
    content: "# Database Schema\n\n## User Table\n```sql\nCREATE TABLE users (\n    id SERIAL PRIMARY KEY,\n    email VARCHAR(255) UNIQUE NOT NULL,\n    password_hash VARCHAR(255) NOT NULL,\n    created_at TIMESTAMP DEFAULT NOW()\n);\n```".to_string(),
};

Fields§

§id: String

Unique identifier in YYYYMMDD_name format (e.g., “20240115_user_auth”)

§name: String

Human-readable title for the specification

§description: String

Brief summary of what the specification covers

§status: SpecStatus

Current progress state of the specification

§created_at: DateTime<Utc>

Timestamp when the specification was created

§updated_at: DateTime<Utc>

Timestamp of the last modification

§content: String

Full specification content in Markdown format

Trait Implementations§

Source§

impl Clone for Specification

Source§

fn clone(&self) -> Specification

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Specification

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Specification

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Specification

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,