ContentItem Pennington.Pipeline
Union of all content item states flowing through the pipeline.
Cases
DiscoveredItemDiscoveredItem- A content item discovered by a content service but not yet run through the pipeline.
FailedItemFailedItem- A content item that failed during parsing or rendering.
ParsedItemParsedItem- A content item whose front matter and raw markdown body have been parsed.
RenderedItemRenderedItem- A content item whose body has been rendered to HTML.
Properties
RouteContentRoute- The route for the current item regardless of state.
Valueobject- Wrapped case instance; inspect via pattern matching on the case types.
Constructors
ContentItem
#public ContentItem(DiscoveredItem value)
Wraps a DiscoveredItem.
Parameters
valueDiscoveredItem
ContentItem
#public ContentItem(ParsedItem value)
Wraps a ParsedItem.
Parameters
valueParsedItem
ContentItem
#public ContentItem(RenderedItem value)
Wraps a RenderedItem.
Parameters
valueRenderedItem
ContentItem
#public ContentItem(FailedItem value)
Wraps a FailedItem.
Parameters
valueFailedItem
Pennington.Pipeline.ContentItem
namespace Pennington.Pipeline;
/// Union of all content item states flowing through the pipeline.
public struct ContentItem
{
/// Wraps a DiscoveredItem.
public ContentItem(DiscoveredItem value)
;
/// Wraps a ParsedItem.
public ContentItem(ParsedItem value)
;
/// Wraps a RenderedItem.
public ContentItem(RenderedItem value)
;
/// Wraps a FailedItem.
public ContentItem(FailedItem value)
;
/// A content item discovered by a content service but not yet run through the pipeline.
public record DiscoveredItem(ContentRoute Route, ContentSource Source) : object, IEquatable<DiscoveredItem>
/// A content item that failed during parsing or rendering.
public record FailedItem(ContentRoute Route, ContentError Error) : object, IEquatable<FailedItem>
/// A content item whose front matter and raw markdown body have been parsed.
public record ParsedItem(ContentRoute Route, IFrontMatter Metadata, string RawMarkdown) : object, IEquatable<ParsedItem>
/// A content item whose body has been rendered to HTML.
public record RenderedItem(ContentRoute Route, IFrontMatter Metadata, RenderedContent Content) : object, IEquatable<RenderedItem>
/// The route for the current item regardless of state.
public ContentRoute Route { get; }
/// Wrapped case instance; inspect via pattern matching on the case types.
public object Value { get; }
}