Struct ReviewEnvelopeOutput

Source

pub struct ReviewEnvelopeOutput {
    pub event: Option<ReviewEnvelopeEvent>,
    pub body: String,
    pub summary: ReviewEnvelopeSummary,
    pub comments: Vec<ReviewComment>,
    pub marker_regex: String,
    pub marker_regex_flags: String,
    pub meta: ReviewEnvelopeMeta,
}

Expand description

Envelope emitted by fallow --format review-github / review-gitlab. Consumed by action/scripts/review.sh and ci/scripts/review.sh to post inline PR / MR review comments.

Fields§

§event: Option<ReviewEnvelopeEvent>

GitHub review event. Omitted for GitLab.

§body: String

Review summary body (rendered above per-line comments). Deprecated in v2 envelopes: prefer summary.body, which is byte-identical to this field but carries a stable fingerprint for reconciliation. Kept on v2 emit so v1 consumers that only look at body keep working.

§summary: ReviewEnvelopeSummary

Sticky summary block (v2). Always present on v2 emit. Consumers reconcile a single sticky PR/MR summary comment by ReviewEnvelopeSummary::fingerprint matching, then upsert ReviewEnvelopeSummary::body in place. Synthesized empty when deserializing v1 historical input.

§comments: Vec<ReviewComment>

Per-line comments. Each is either a GitHubReviewComment or a GitLabReviewComment depending on meta.provider.

§marker_regex: String

Regex consumers run against every existing PR/MR comment body to extract a fallow-emitted fingerprint marker. Capture group 1 is the fingerprint string (a bare 16-char hex hash for single-finding comments, or <kind>:<16-char-hex> for compositions such as merged: for same-line collapsed comments).

The pattern is anchored with ^ / $ and relies on multiline matching to anchor at line boundaries inside a multi-line comment body. Multiline is NOT baked into the pattern via (?m) (which JavaScript RegExp rejects as Invalid group); instead the consumer passes Self::marker_regex_flags as the flags argument to its regex engine. JavaScript: new RegExp(env.marker_regex, env.marker_regex_flags). Rust: regex::RegexBuilder::new(pat) .multi_line(flags.contains('m')).build() (or any equivalent).

§marker_regex_flags: String

Flags consumers pass alongside Self::marker_regex when constructing their regex engine. Currently always "m" (multiline so the anchored ^ / $ match at every line boundary within a comment body). Emitting flags as a separate field instead of baking (?m) into the pattern keeps the wire compatible with JavaScript RegExp, which rejects inline flag groups outside a (?flags:X) grouping.

§meta: ReviewEnvelopeMeta

Envelope metadata block.

ReviewEnvelopeOutput

Struct ReviewEnvelopeOutput Copy item path

Fields§

Trait Implementations§

impl Clone for ReviewEnvelopeOutput

fn clone(&self) -> ReviewEnvelopeOutput

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

impl Debug for ReviewEnvelopeOutput

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

impl Serialize for ReviewEnvelopeOutput

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

Auto Trait Implementations§

impl Freeze for ReviewEnvelopeOutput

impl RefUnwindSafe for ReviewEnvelopeOutput

impl Send for ReviewEnvelopeOutput

impl Sync for ReviewEnvelopeOutput

impl Unpin for ReviewEnvelopeOutput

impl UnsafeUnpin for ReviewEnvelopeOutput

impl UnwindSafe for ReviewEnvelopeOutput

Blanket Implementations§

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> CloneToUninit for Twhere T: Clone,

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

impl<T> DynClone for Twhere T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

impl<'a, T> FromIn<'a, T> for T

fn from_in(t: T, _: &'a Allocator) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>where F: FnOnce(&Self) -> bool,

impl<'a, T, U> IntoIn<'a, U> for Twhere U: FromIn<'a, T>,

fn into_in(self, allocator: &'a Allocator) -> U

impl<D> OwoColorize for D

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where C: Color,

fn black(&self) -> FgColorDisplay<'_, Black, Self>

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

fn red(&self) -> FgColorDisplay<'_, Red, Self>

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

fn green(&self) -> FgColorDisplay<'_, Green, Self>

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

fn white(&self) -> FgColorDisplay<'_, White, Self>

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Struct ReviewEnvelopeOutput

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

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

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

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

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

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

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

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

impl<'a, T, U> IntoIn<'a, U> for T
where U: FromIn<'a, T>,

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

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

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

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

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