para

use v6.d;
use Syndicate::Item;
use Syndicate::Utils;

unit role Syndicate::Feed:ver<0.0.6>:auth<zef:sasha>;

has Str $.title;
has Str $.link;
has Str $.description;
has Str $.generator;
has Str $.language;
has @!items of Syndicate::Item is built;
method items() { @!items.List }
# Caches assume the feed object is immutable after construction.
# Any mutation to attributes after the first call to .Str or .to-hash
# will not be reflected in the cached output.
has Str $!cached-str;
has Str $!cached-pretty-str;
has Lock $!cache-lock = Lock.new;
# Item hashes are built once and deep-cloned on every call so callers can
# never mutate the cache (see sanitize), mirroring the JSONFeed cache.
has $!cached-item-hashes;

method to-hash(:$clone = True) {
    self.to-hash-common(:$clone)
}

method to-hash-common(:$clone = True) {
    my %h;
    %h<title>       = $.title       if $.title.defined;
    %h<link>        = $.link        if $.link.defined;
    %h<description> = $.description if $.description.defined;
    %h<generator>   = $.generator   if $.generator.defined;
    %h<language>    = $.language    if $.language.defined;
    if @!items {
        # Guarded by the cache lock so concurrent to-hash calls never race
        # the lazy build (the write is idempotent, but this matches the
        # lock-discipline of Str/JSONFeed).
        $!cache-lock.protect: {
            $!cached-item-hashes //= @!items.map(*.to-hash).Array;
        }
        # Cloned per call so callers can never mutate the cache (see
        # sanitize); :!clone opts out of the O(items) copy for hot paths.
        %h<items> = $clone
            ?? $!cached-item-hashes.map({ sanitize($_) }).Array
            !! $!cached-item-hashes;
    }
    %h
}

method Str {
    $!cached-str // $!cache-lock.protect: {
        $!cached-str //= '<?xml version="1.0" encoding="UTF-8"?>' ~ "\n" ~ self.XML.Str
    }
}

# Stringify the feed, optionally with human-friendly indentation. The default
# (C<Str> / C<str()> without C<:pretty>) is unchanged: one line, maximum
# byte-compactness, matching the pre-existing behaviour. With C<:pretty> the
# XML is re-indented via L<C<indent-xml>|rakudoc:Syndicate::Utils>: the XML
# declaration stays on its own line and each element is indented two spaces per
# nesting level. Pretty output is derived from the cached compact C<Str>, so
# removing all whitespace from it yields exactly the compact form: the two
# differ only by inserted whitespace and parse identically.
method str(:$pretty = False) {
    $pretty ?? self!pretty-str !! self.Str
}

method !pretty-str {
    $!cached-pretty-str // $!cache-lock.protect: {
        # Derive from the cached compact Str (not a fresh XML serialization) so
        # plain/pretty are guaranteed to differ only by inserted whitespace,
        # even though XML::Element serializes attribute order non-deterministically.
        $!cached-pretty-str //= indent-xml(self.Str)
    }
}

# Convert this parsed feed into a Syndicate::Builder::Feed for re-emission in
# any format. Loaded at runtime (require) to avoid a compile-time cycle: the
# builder imports Syndicate::Feed, so a compile-time reference here would be
# circular.
method to-builder() {
    require Syndicate::Builder::Feed;
    Syndicate::Builder::Feed.new-from-feed(self)
}



head

All feed types (RSS, Atom, JSONFeed) do this role, providing a uniform
interface for accessing common feed metadata.


item

code

root

FeedResult

Extensions

React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<AI|file:../mcp/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>
    =item2 L<Hand these documents to an AI assistant|file:../mcp/index.podlite>

=end nested
=begin nested :!nested
=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>

=end nested
=end React


Built with L<Podlite|https://podlite.org> — the markup and publishing tools behind this site.


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


Feed

NAME

DESCRIPTION

ATTRIBUTES

METHODS

Syndicate v0.0.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation