Trait biome_formatter::Format

pub trait Format<Context> {
    // Required method
    fn fmt(&self, f: &mut Formatter<'_, Context>) -> FormatResult<()>;
}

Formatting trait for types that can create a formatted representation. The biome_formatter equivalent to std::fmt::Display.

Example

Implementing Format for a custom struct

use biome_formatter::{format, write, IndentStyle, LineWidth};
use biome_formatter::prelude::*;
use biome_rowan::TextSize;

struct Paragraph(String);

impl Format<SimpleFormatContext> for Paragraph {
    fn fmt(&self, f: &mut Formatter<SimpleFormatContext>) -> FormatResult<()> {
        write!(f, [
            hard_line_break(),
            dynamic_text(&self.0, TextSize::from(0)),
            hard_line_break(),
        ])
    }
}

let paragraph = Paragraph(String::from("test"));
let formatted = format!(SimpleFormatContext::default(), [paragraph])?;

assert_eq!("test\n", formatted.print()?.as_code());

Required Methods

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

Formats the object using the given formatter.

Implementations on Foreign Types

impl<Context> Format<Context> for ()

fn fmt(&self, _: &mut Formatter<'_, Context>) -> FormatResult<()>

impl<L: Language, Context> Format<Context> for SyntaxTriviaPiece<L>

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

impl<T, Context> Format<Context> for Option<T>

where T: Format<Context>,

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

impl<T, Context> Format<Context> for &T

where T: ?Sized + Format<Context>,

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

impl<T, Context> Format<Context> for &mut T

where T: ?Sized + Format<Context>,

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

impl<T, Context> Format<Context> for SyntaxResult<T>

where T: Format<Context>,

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

Implementors

impl<'fmt, Context> Format<Context> for Argument<'fmt, Context>

impl<C, L> Format<C> for FormatRemoved<'_, L>

where L: Language + 'static, C: CstFormatContext<Language = L>,

impl<Context> Format<Context> for FormatDanglingComments<'_, Context::Language>

where Context: CstFormatContext,

impl<Context> Format<Context> for FormatLeadingComments<'_, Context::Language>

where Context: CstFormatContext,

impl<Context> Format<Context> for FormatTrailingComments<'_, Context::Language>

where Context: CstFormatContext,

impl<Context> Format<Context> for Align<'_, Context>

impl<Context> Format<Context> for BestFitting<'_, Context>

impl<Context> Format<Context> for BlockIndent<'_, Context>

impl<Context> Format<Context> for Dedent<'_, Context>

impl<Context> Format<Context> for DynamicText<'_>

impl<Context> Format<Context> for ExpandParent

impl<Context> Format<Context> for FormatLabelled<'_, Context>

impl<Context> Format<Context> for Group<'_, Context>

impl<Context> Format<Context> for HardSpace

impl<Context> Format<Context> for IfGroupBreaks<'_, Context>

impl<Context> Format<Context> for Indent<'_, Context>

impl<Context> Format<Context> for IndentIfGroupBreaks<'_, Context>

impl<Context> Format<Context> for Line

impl<Context> Format<Context> for LineSuffix<'_, Context>

impl<Context> Format<Context> for LineSuffixBoundary

impl<Context> Format<Context> for LocatedTokenText

impl<Context> Format<Context> for Space

impl<Context> Format<Context> for StaticText

impl<Context> Format<Context> for Arguments<'_, Context>

impl<Context> Format<Context> for FormatSkippedTokenTrivia<'_, Context::Language>

where Context: CstFormatContext,

impl<Context, T> Format<Context> for FormatWith<Context, T>

where T: Fn(&mut Formatter<'_, Context>) -> FormatResult<()>,

impl<F, Context> Format<Context> for Memoized<F, Context>

where F: Format<Context>,

impl<L, C> Format<C> for CleanedNumberLiteralText<'_, L>

where L: Language + 'static, C: CstFormatContext<Language = L>,

impl<L, C> Format<C> for FormatOnlyIfBreaks<'_, '_, L, C>

where L: Language + 'static, C: CstFormatContext<Language = L>,

impl<L, C> Format<C> for FormatReplaced<'_, '_, L, C>

where L: Language + 'static, C: CstFormatContext<Language = L>,

impl<L: Language + 'static, C> Format<C> for FormatTrimmedToken<'_, L>

where C: CstFormatContext<Language = L>,

impl<L: Language, Context> Format<Context> for SyntaxTokenCowSlice<'_, L>

impl<N, R, C> Format<C> for FormatSeparatedElement<N, R>

where N: AstNode, N::Language: 'static, R: FormatSeparatedElementRule<N, Context = C>, C: CstFormatContext<Language = N::Language>,

impl<T, Context> Format<Context> for FormatOnce<T, Context>

where T: FnOnce(&mut Formatter<'_, Context>) -> FormatResult<()>,

impl<T, R> Format<<R as FormatRule<T>>::Context> for FormatOwnedWithRule<T, R>

where R: FormatRule<T>,

impl<T, R> Format<<R as FormatRule<T>>::Context> for FormatRefWithRule<'_, T, R>

where R: FormatRule<T>,