1 /*
2 FS is a read-only filesystem interface to a Lemmy instance.
3 The root of the filesystem holds directories for each community known to the filesystem.
4 Local communities are named by their plain name verbatim.
5 Remote communities have the instance address as a suffix. For example:
6 
7 	golang/
8 	plan9@lemmy.sdf.org/
9 	openbsd@lemmy.sdf.org/
10 
11 Each community directory holds posts.
12 Each post has associated a directory numbered by its ID.
13 Within each post are the following entries:
14 
15 	body     Text describing, or accompanying, the post.
16 	creator  The numeric user ID of the post's author.
17 	title    The post's title.
18 	url      A URL pointing to a picture or website, usually as the
19 	         subject of the post if present.
20 	123...   Numbered files containing user discussion.
21 	         Described in more detail below.
22 
23 A comment file is named by its unique comment ID.
24 Its contents are a RFC 5322 message.
25 The message body contains the text content of the comment.
26 The header contains the following fields:
27 
28 	From       User ID of the comment's author.
29 	References A list of comment IDs referenced by this comment, one
30 	           per line. The first line is the immediately referenced
31 	           comment (the parent); the second is the grandparent and
32 	           so on. This can be used by readers to render discussion
33 	           threads.
34 
35 FS satisfies io/fs.FS.
36 */
37 package fs