Struct Fragment 

pub struct Fragment<T: Serialize> {
    pub path: PathBuf,
    pub content: T,
}

A fragment extracted from an OpenAPI specification.

Represents a piece of the original specification that should be written to a separate file. The content can be any serializable type, typically Components, OpenApi, or a custom subset of schemas.

Type Parameters

• T - The type of content in this fragment. Must implement Serialize for file output.

Example

use clawspec_core::split::Fragment;
use std::path::PathBuf;
use utoipa::openapi::Components;

let fragment = Fragment {
    path: PathBuf::from("schemas/common.yaml"),
    content: Components::new(),
};

Fields

path: PathBuf

Relative path where this fragment should be written.

This path is relative to the main OpenAPI specification file. The main spec will use $ref pointing to this path.

content: T

The content to serialize into the fragment file.

Implementations

impl<T: Serialize> Fragment<T>

pub fn new(path: impl Into<PathBuf>, content: T) -> Self

Creates a new fragment with the given path and content.

pub fn to_yaml(&self) -> Result<String, YamlError>

Available on crate feature yaml only.

Serializes the fragment content to a YAML string.

Requires the yaml feature.

Example

use clawspec_core::split::Fragment;

let fragment = Fragment::new("common.yaml", components);
let yaml = fragment.to_yaml()?;
std::fs::write(&fragment.path, yaml)?;

Errors

Returns a YamlError if serialization fails.

Trait Implementations

impl<T: Clone + Serialize> Clone for Fragment<T>

fn clone(&self) -> Fragment<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + Serialize> Debug for Fragment<T>

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

Formats the value using the given formatter.