License, Readme, start documentation
Done: - Base Todo: - Primitives - Unparsed - Object - Actor - Activity - Link
This commit is contained in:
parent
a86050d234
commit
4f4cec8fec
9 changed files with 1393 additions and 37 deletions
|
@ -1,7 +1,11 @@
|
||||||
[package]
|
[package]
|
||||||
name = "activitystreams-new"
|
name = "activitystreams-new"
|
||||||
version = "0.1.0"
|
version = "0.1.0"
|
||||||
|
license = "GPL-3.0"
|
||||||
authors = ["asonix <asonix@asonix.dog>"]
|
authors = ["asonix <asonix@asonix.dog>"]
|
||||||
|
repository = "https://git.asonix.dog/asonix/activitystreams-sketch"
|
||||||
|
readme = "README.md"
|
||||||
|
keywords = ["activitystreams", "activitypub"]
|
||||||
edition = "2018"
|
edition = "2018"
|
||||||
|
|
||||||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
|
||||||
|
|
674
LICENSE
Normal file
674
LICENSE
Normal file
|
@ -0,0 +1,674 @@
|
||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
244
README.md
Normal file
244
README.md
Normal file
|
@ -0,0 +1,244 @@
|
||||||
|
# ActivityStreams
|
||||||
|
__A set of Traits and Types that make up the ActivityStreams and ActivityPub specifications__
|
||||||
|
|
||||||
|
- [Read the documentation on docs.rs](https://docs.rs/activitystreams)
|
||||||
|
- [Find the crate on crates.io](https://crates.io/crates/activitystreams)
|
||||||
|
- [hit me up on Mastodon](https://asonix.dog/@asonix)
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
First, add ActivityStreams to your dependencies
|
||||||
|
```toml
|
||||||
|
activitystreams = "0.6.2"
|
||||||
|
```
|
||||||
|
|
||||||
|
### Types
|
||||||
|
|
||||||
|
The project is laid out by Kind => vocabulary => Type
|
||||||
|
|
||||||
|
So to use an ActivityStreams Video, you'd write
|
||||||
|
```rust
|
||||||
|
use activitystreams_new::object::Video;
|
||||||
|
let video = Video::builder().finish();
|
||||||
|
```
|
||||||
|
|
||||||
|
And to use an ActivityPub profile, you'd write
|
||||||
|
```rust
|
||||||
|
use activitystreams_new::object::{ApObject, Profile};
|
||||||
|
let inner = Profile::builder().finish();
|
||||||
|
let profile = ApObject::builder()
|
||||||
|
.inner(inner)
|
||||||
|
.finish();
|
||||||
|
```
|
||||||
|
|
||||||
|
There's only one kind of Link
|
||||||
|
```rust
|
||||||
|
use activitystreams_new::link::Mention;
|
||||||
|
let mention = Mention::builder().finish();
|
||||||
|
```
|
||||||
|
|
||||||
|
### Fields
|
||||||
|
|
||||||
|
Many fields on the provided types are wrapped in `OneOrMany<>` or have a type of `AnyBase`. This
|
||||||
|
is because the activitystreams spec is very open as to what is considered a valid structure.
|
||||||
|
|
||||||
|
For example, the Object type in ActivityStreams has a `summary` field, which can either be
|
||||||
|
represented as an `xsd:string` or an `rdf:langString`. It also states that the `summary` field
|
||||||
|
is not `functional`, meaning that any number of `xsd:string` or `rdf:langString`, or a
|
||||||
|
combination thereof, can be present. This library represents this as `Option<OneOrMany<AnyString>>`.
|
||||||
|
|
||||||
|
This resulting type is exactly specific enough to match the following valid ActivityStreams
|
||||||
|
json, without matching any invalid json.
|
||||||
|
|
||||||
|
With no summary:
|
||||||
|
```json
|
||||||
|
{}
|
||||||
|
```
|
||||||
|
|
||||||
|
With a sring summary:
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"summary": "A string"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
With an rdf langstring
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"summary": {
|
||||||
|
"@value": "A string",
|
||||||
|
"@language": "en"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
With multiple values
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"summary": [
|
||||||
|
{
|
||||||
|
"@value": "A string",
|
||||||
|
"@language": "en"
|
||||||
|
},
|
||||||
|
"An xsd:string this time"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
It may seem like interacting with these types might get unweildy, there are some custom methods
|
||||||
|
implemented on the `OneOrMany` type depending on what's inside of it.
|
||||||
|
|
||||||
|
```rust
|
||||||
|
fn from_xsd_string<T>(&mut self, T) -> Self;
|
||||||
|
fn from_rdf_lang_string<T>(&mut self, T) -> Self;
|
||||||
|
|
||||||
|
fn as_single_xsd_string(&self) -> Option<&XsdString>;
|
||||||
|
fn as_single_rdf_langstring(&self) -> Option<&RdfLangString>;
|
||||||
|
|
||||||
|
fn single_xsd_string(self) -> Option<XsdString>;
|
||||||
|
fn single_rdf_lang_string(self) -> Option<RdfLangString>;
|
||||||
|
|
||||||
|
fn add_xsd_string<T>(&mut self, T) -> &mut Self;
|
||||||
|
fn add_rdf_lang_string<T>(&mut self, T) -> &mut Self;
|
||||||
|
```
|
||||||
|
These methods provide access to setting and fetching uniformly typed data, as well as deleting
|
||||||
|
the data. In the setter methods, the type parameter T is bound by
|
||||||
|
`Into<XsdString>` or `Into<RdfLangString>`. This allows passing values to the method that
|
||||||
|
can be converted into the types, rather than requiring the caller to perform the conversion.
|
||||||
|
|
||||||
|
Types like `XsdString` and `RdfLangString` can be found in the `primitives` module. Unless
|
||||||
|
you're building your own custom types, you shouldn't need to import them yourself. They each
|
||||||
|
implement `FromStr` for parsing and `Display` to convert back to strings, as well as `From` and
|
||||||
|
`Into` or `TryFrom` and `TryInto` for types you might expect them to (e.g.
|
||||||
|
`XsdNonNegativeInteger` implements `From<u64>` and `Into<u64>`).
|
||||||
|
|
||||||
|
### Traits
|
||||||
|
|
||||||
|
Since ActivityStreams is a heirarchical structure of data, it's represented as structs containing
|
||||||
|
other structs. This means that the `context` field, which can be present on any ActivityStreams type,
|
||||||
|
will be located in the innermost struct. In order to avoid writing code like
|
||||||
|
`ap_object.collection.object.base.context = Some(context())`, this library provides traits that are
|
||||||
|
automatically implmeneted for provided types.
|
||||||
|
|
||||||
|
For example, the `BaseExt` trait provides the following methods for `context`,
|
||||||
|
```rust
|
||||||
|
fn context(&self) -> Option<&OneOrMany<AnyBase>>;
|
||||||
|
|
||||||
|
fn set_context<T>(&mut self, context: T) -> &mut Self
|
||||||
|
where
|
||||||
|
T: Into<AnyBase>;
|
||||||
|
|
||||||
|
fn set_many_contexts<I, T>(&mut self, items: I) -> &mut Self
|
||||||
|
where
|
||||||
|
I: IntoIterator<Item = T>,
|
||||||
|
T: Into<AnyBase>;
|
||||||
|
|
||||||
|
fn add_context<T>(&mut self, context: T) -> &mut Self
|
||||||
|
where
|
||||||
|
T: Into<AnyBase>;
|
||||||
|
|
||||||
|
fn take_context(&mut self) -> Option<OneOrMany<AnyBase>>;
|
||||||
|
fn delete_context(&mut self) -> &mut Self;
|
||||||
|
```
|
||||||
|
|
||||||
|
For fields with more specific bounds, like `id`,
|
||||||
|
```rust
|
||||||
|
fn id(&self) -> Option<&XsdAnyUri>;
|
||||||
|
fn set_id(&mut self, XsdAnyUri) -> &mut Self;
|
||||||
|
fn take_id(&self) -> Option<XsdAnyUri>;
|
||||||
|
fn delete_id(&mut self) -> &mut Self;
|
||||||
|
```
|
||||||
|
|
||||||
|
The full list of extension traits that implement methods like these on types can be found in the
|
||||||
|
prelude module. By using `use activitystreams_new::prelude::*;` all of the methods will be
|
||||||
|
implemented for types containing their fields.
|
||||||
|
|
||||||
|
### Markers
|
||||||
|
|
||||||
|
This library provides a number of traits, such as `Object`, `Link`, `Actor`, `Activity`,
|
||||||
|
`Collection`, and `CollectionPage`. The majority of these traits exist solely to "mark" types,
|
||||||
|
meaning they don't provide value, at runtime, but exist to add constraints to generics at
|
||||||
|
compiletime.
|
||||||
|
|
||||||
|
If you want to make a function that manipulates an Activity, but not a normal object, you could
|
||||||
|
bound the function like so:
|
||||||
|
```rust
|
||||||
|
fn manipulator<T>(activity: T) -> Result<&mut ObjectProperties, SomeErrorType>
|
||||||
|
where
|
||||||
|
T: Activity + BaseExt,
|
||||||
|
{
|
||||||
|
activity
|
||||||
|
.set_id("https://example.com".parse()?)
|
||||||
|
.set_context(context())
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Kinds
|
||||||
|
|
||||||
|
This library has a set of unit structs that serialize and deserialize to strings. This is to
|
||||||
|
enable different ActivityPub Object types to be deserialized into different Named structs.
|
||||||
|
These can be found in `activitystreams_new::objects::kind`, and similar paths.
|
||||||
|
|
||||||
|
To build your own Person struct, for example, you could write
|
||||||
|
```rust
|
||||||
|
use activitystreams_new::actor::kind::PersonType;
|
||||||
|
|
||||||
|
#[derive(serde::Deserialize, serde::Serialize)]
|
||||||
|
pub struct MyPerson {
|
||||||
|
// Do a rename since `type` is not a valid rust field name
|
||||||
|
#[serde(rename = "type")]
|
||||||
|
kind: PersonType,
|
||||||
|
}
|
||||||
|
```
|
||||||
|
And this type would only deserialize for JSON where `"type":"Person"`
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Basic
|
||||||
|
|
||||||
|
```rust
|
||||||
|
use activitystreams_new::{
|
||||||
|
context,
|
||||||
|
object::{ApObject, Video},
|
||||||
|
prelude::*,
|
||||||
|
primitives::{XsdAnyUri, XsdString},
|
||||||
|
};
|
||||||
|
|
||||||
|
fn main() -> Result<(), anyhow::Error> {
|
||||||
|
let mut video: ApObject<Video> = ApObject::default();
|
||||||
|
|
||||||
|
video
|
||||||
|
.set_context(context())
|
||||||
|
.set_id("https://example.com/@example/lions".parse()?)
|
||||||
|
.set_media_type("video/webm".parse()?)
|
||||||
|
.set_url("https://example.com/@example/lions/video.webm".parse::<XsdAnyUri>()?)
|
||||||
|
.set_summary(XsdString::from("A cool video"))
|
||||||
|
.set_duration("PT4M20S".parse()?)
|
||||||
|
.set_shares("https://example.com/@example/lions/video.webm#shares".parse()?);
|
||||||
|
|
||||||
|
println!("Video, {:#?}", video);
|
||||||
|
|
||||||
|
let s = serde_json::to_string(&video)?;
|
||||||
|
|
||||||
|
println!("json, {}", s);
|
||||||
|
|
||||||
|
let v: ApObject<Video> = serde_json::from_str(&s)?;
|
||||||
|
|
||||||
|
println!("Video again, {:#?}", v);
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
Feel free to open issues for anything you find an issue with. Please note that any contributed code will be licensed under the GPLv3.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Copyright © 2020 Riley Trautman
|
||||||
|
|
||||||
|
ActivityStreams is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
|
||||||
|
|
||||||
|
ActivityStreams is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. This file is part of ActivityStreams.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License along with ActivityStreams. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
|
|
@ -1,24 +1,25 @@
|
||||||
use activitystreams_new::{
|
use activitystreams_new::{
|
||||||
context,
|
context,
|
||||||
object::{ApObject, Video},
|
object::{ApObject, Video},
|
||||||
|
prelude::*,
|
||||||
primitives::{XsdAnyUri, XsdString},
|
primitives::{XsdAnyUri, XsdString},
|
||||||
};
|
};
|
||||||
|
|
||||||
fn main() -> Result<(), Box<dyn std::error::Error>> {
|
fn main() -> Result<(), anyhow::Error> {
|
||||||
let video = Video::builder()
|
let mut video: ApObject<Video> = ApObject::default();
|
||||||
.context(context())
|
|
||||||
.id("https://example.com/@example/lions".parse::<XsdAnyUri>()?)
|
|
||||||
.url("https://example.com/@example/lions/video.webm".parse::<XsdAnyUri>()?)
|
|
||||||
.summary(XsdString::from("A cool video"))
|
|
||||||
.media_type("video/webm".parse()?)
|
|
||||||
.duration("PT4M20S".parse()?)
|
|
||||||
.build();
|
|
||||||
|
|
||||||
let v = ApObject::builder().inner(video).build();
|
video
|
||||||
|
.set_context(context())
|
||||||
|
.set_id("https://example.com/@example/lions".parse()?)
|
||||||
|
.set_media_type("video/webm".parse()?)
|
||||||
|
.set_url("https://example.com/@example/lions/video.webm".parse::<XsdAnyUri>()?)
|
||||||
|
.set_summary(XsdString::from("A cool video"))
|
||||||
|
.set_duration("PT4M20S".parse()?)
|
||||||
|
.set_shares("https://example.com/@example/lions/video.webm#shares".parse()?);
|
||||||
|
|
||||||
println!("Video, {:#?}", v);
|
println!("Video, {:#?}", video);
|
||||||
|
|
||||||
let s = serde_json::to_string(&v)?;
|
let s = serde_json::to_string(&video)?;
|
||||||
|
|
||||||
println!("json, {}", s);
|
println!("json, {}", s);
|
||||||
|
|
||||||
|
|
|
@ -2,7 +2,6 @@ use activitystreams_new::{
|
||||||
collection::OrderedCollection,
|
collection::OrderedCollection,
|
||||||
object::{ApObject, Page},
|
object::{ApObject, Page},
|
||||||
prelude::*,
|
prelude::*,
|
||||||
traits::Extends,
|
|
||||||
};
|
};
|
||||||
use anyhow::Error;
|
use anyhow::Error;
|
||||||
|
|
||||||
|
@ -53,14 +52,14 @@ fn main() -> Result<(), Error> {
|
||||||
.many()
|
.many()
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.flatten()
|
.flatten()
|
||||||
.filter_map(|any_object| any_object.object())
|
.filter_map(|any_base| any_base.take_base())
|
||||||
.map(|object| object.solidify().and_then(|o| o.extend()))
|
.map(|base| base.solidify().and_then(|o| o.extend()))
|
||||||
.collect::<Result<Vec<_>, _>>()?;
|
.collect::<Result<Vec<_>, _>>()?;
|
||||||
|
|
||||||
println!("{:#?}", v);
|
println!("{:#?}", v);
|
||||||
let v = v
|
let v = v
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.map(|o| o.retracts().and_then(|o| o.into_generic()))
|
.map(|o| o.into_any_base())
|
||||||
.collect::<Result<Vec<_>, _>>()?;
|
.collect::<Result<Vec<_>, _>>()?;
|
||||||
|
|
||||||
collection.set_many_items(v);
|
collection.set_many_items(v);
|
||||||
|
|
428
src/base.rs
428
src/base.rs
|
@ -1,3 +1,32 @@
|
||||||
|
//! Types and traits for dealing with the base attributes common to all ActivityStreams Objects and
|
||||||
|
//! Links
|
||||||
|
//!
|
||||||
|
//! ```rust
|
||||||
|
//! # fn main() -> Result<(), anyhow::Error> {
|
||||||
|
//! use activitystreams_new::{
|
||||||
|
//! context,
|
||||||
|
//! object::Video,
|
||||||
|
//! prelude::*,
|
||||||
|
//! primitives::XsdString,
|
||||||
|
//! security,
|
||||||
|
//! };
|
||||||
|
//! let mut video = Video::default();
|
||||||
|
//!
|
||||||
|
//! video
|
||||||
|
//! .set_id("https://example.com".parse()?)
|
||||||
|
//! .set_context(context())
|
||||||
|
//! .add_context(security())
|
||||||
|
//! .set_name(XsdString::from("Hello"));
|
||||||
|
//!
|
||||||
|
//! let any_base = video.into_any_base()?;
|
||||||
|
//!
|
||||||
|
//! let mut new_video = Video::default();
|
||||||
|
//!
|
||||||
|
//! new_video.set_preview(any_base);
|
||||||
|
//! #
|
||||||
|
//! # Ok(())
|
||||||
|
//! # }
|
||||||
|
//! ```
|
||||||
use crate::{
|
use crate::{
|
||||||
either::Either,
|
either::Either,
|
||||||
markers,
|
markers,
|
||||||
|
@ -6,20 +35,100 @@ use crate::{
|
||||||
};
|
};
|
||||||
use typed_builder::TypedBuilder;
|
use typed_builder::TypedBuilder;
|
||||||
|
|
||||||
|
/// Implements conversion between Base<Kind> and other ActivityStreams objects defined in this
|
||||||
|
/// crate
|
||||||
pub trait Extends<Kind>: Sized {
|
pub trait Extends<Kind>: Sized {
|
||||||
|
/// The erro produced must be a StdError
|
||||||
type Error: std::error::Error;
|
type Error: std::error::Error;
|
||||||
|
|
||||||
|
/// Produce an object from the Base
|
||||||
fn extends(base: Base<Kind>) -> Result<Self, Self::Error>;
|
fn extends(base: Base<Kind>) -> Result<Self, Self::Error>;
|
||||||
|
|
||||||
|
/// Produce a base from the object
|
||||||
fn retracts(self) -> Result<Base<Kind>, Self::Error>;
|
fn retracts(self) -> Result<Base<Kind>, Self::Error>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A helper function implemented for all Extends types to easily produce an AnyBase from a given
|
||||||
|
/// object.
|
||||||
|
///
|
||||||
|
/// This is important because many APIs in this crate deal with AnyBases.
|
||||||
|
pub trait ExtendsExt<Kind>: Extends<Kind> {
|
||||||
|
/// Create an AnyBase from the given object
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # fn main() -> Result<(), anyhow::Error> {
|
||||||
|
/// use activitystreams_new::{object::Video, prelude::*};
|
||||||
|
/// let video = Video::default();
|
||||||
|
///
|
||||||
|
/// let any_base = video.into_any_base()?;
|
||||||
|
/// #
|
||||||
|
/// # Ok(())
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
fn into_any_base(self) -> Result<AnyBase, Self::Error>
|
||||||
|
where
|
||||||
|
Kind: serde::ser::Serialize,
|
||||||
|
Self::Error: From<serde_json::Error>,
|
||||||
|
{
|
||||||
|
AnyBase::from_extended(self)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Create an object from an AnyBase
|
||||||
|
///
|
||||||
|
/// Before calling this, make sure the `AnyBase::is_base()` and `AnyBase::kind` match your
|
||||||
|
/// expectations
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # fn main() -> Result<(), anyhow::Error> {
|
||||||
|
/// use activitystreams_new::{object::Video, prelude::*};
|
||||||
|
/// # let video = Video::default();
|
||||||
|
/// # let any_base = video.into_any_base()?;
|
||||||
|
/// let video = Video::from_any_base(any_base)?;
|
||||||
|
/// #
|
||||||
|
/// # Ok(())
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
|
fn from_any_base(any_base: AnyBase) -> Result<Option<Self>, Self::Error>
|
||||||
|
where
|
||||||
|
Kind: serde::de::DeserializeOwned,
|
||||||
|
Self::Error: From<serde_json::Error>,
|
||||||
|
{
|
||||||
|
if let Some(base) = any_base.take_base() {
|
||||||
|
let my_base = base.solidify()?;
|
||||||
|
let extended = my_base.extend::<Self>()?;
|
||||||
|
|
||||||
|
return Ok(Some(extended));
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(None)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Implementation trait for deriving Base methods for a type
|
||||||
|
///
|
||||||
|
/// Any type Implementating AsBase will automatically gain methods provided by BaseExt
|
||||||
pub trait AsBase<Kind>: markers::Base {
|
pub trait AsBase<Kind>: markers::Base {
|
||||||
fn base_ref(&self) -> &Base<Kind>;
|
fn base_ref(&self) -> &Base<Kind>;
|
||||||
fn base_mut(&mut self) -> &mut Base<Kind>;
|
fn base_mut(&mut self) -> &mut Base<Kind>;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Helper methods for interacting with Base types
|
||||||
|
///
|
||||||
|
/// This trait represents methods valid for Any ActivityStreams type, regardless of whether it's a
|
||||||
|
/// Link or an Object.
|
||||||
|
///
|
||||||
|
/// Documentation for the fields related to these methods can be found on the `Base` struct
|
||||||
pub trait BaseExt<Kind>: AsBase<Kind> {
|
pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
|
/// Fetch the context for the current object
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # use activitystreams_new::object::Video;
|
||||||
|
/// # let video = Video::default();
|
||||||
|
/// #
|
||||||
|
/// use activitystreams_new::prelude::*;
|
||||||
|
///
|
||||||
|
/// let video_context = video.context();
|
||||||
|
/// ```
|
||||||
fn context<'a>(&'a self) -> Option<&'a OneOrMany<AnyBase>>
|
fn context<'a>(&'a self) -> Option<&'a OneOrMany<AnyBase>>
|
||||||
where
|
where
|
||||||
Kind: 'a,
|
Kind: 'a,
|
||||||
|
@ -27,6 +136,18 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self.base_ref().context.as_ref()
|
self.base_ref().context.as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set the context for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of context
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # use activitystreams_new::object::Video;
|
||||||
|
/// # let mut video = Video::default();
|
||||||
|
/// #
|
||||||
|
/// use activitystreams_new::{context, prelude::*};
|
||||||
|
///
|
||||||
|
/// video.set_context(context());
|
||||||
|
/// ```
|
||||||
fn set_context<T>(&mut self, context: T) -> &mut Self
|
fn set_context<T>(&mut self, context: T) -> &mut Self
|
||||||
where
|
where
|
||||||
T: Into<AnyBase>,
|
T: Into<AnyBase>,
|
||||||
|
@ -35,6 +156,18 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set many contexts for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of context
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # use activitystreams_new::object::Video;
|
||||||
|
/// # let mut video = Video::default();
|
||||||
|
/// #
|
||||||
|
/// use activitystreams_new::{context, prelude::*, security};
|
||||||
|
///
|
||||||
|
/// video.set_many_contexts(vec![context(), security()]);
|
||||||
|
/// ```
|
||||||
fn set_many_contexts<I, T>(&mut self, items: I) -> &mut Self
|
fn set_many_contexts<I, T>(&mut self, items: I) -> &mut Self
|
||||||
where
|
where
|
||||||
I: IntoIterator<Item = T>,
|
I: IntoIterator<Item = T>,
|
||||||
|
@ -45,6 +178,20 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Add a context to the current object
|
||||||
|
///
|
||||||
|
/// This does not overwrite the contents of context, only appends a new item
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # use activitystreams_new::object::Video;
|
||||||
|
/// # let mut video = Video::default();
|
||||||
|
/// #
|
||||||
|
/// use activitystreams_new::{context, prelude::*, security};
|
||||||
|
///
|
||||||
|
/// video
|
||||||
|
/// .add_context(context())
|
||||||
|
/// .add_context(security());
|
||||||
|
/// ```
|
||||||
fn add_context<T>(&mut self, context: T) -> &mut Self
|
fn add_context<T>(&mut self, context: T) -> &mut Self
|
||||||
where
|
where
|
||||||
T: Into<AnyBase>,
|
T: Into<AnyBase>,
|
||||||
|
@ -60,15 +207,41 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take the context from the current object, leaving nothing
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # use activitystreams_new::object::Video;
|
||||||
|
/// # let mut video = Video::default();
|
||||||
|
/// #
|
||||||
|
/// use activitystreams_new::prelude::*;
|
||||||
|
///
|
||||||
|
/// if let Some(context) = video.take_context() {
|
||||||
|
/// println!("{:?}", context);
|
||||||
|
/// }
|
||||||
|
/// ```
|
||||||
fn take_context(&mut self) -> Option<OneOrMany<AnyBase>> {
|
fn take_context(&mut self) -> Option<OneOrMany<AnyBase>> {
|
||||||
self.base_mut().context.take()
|
self.base_mut().context.take()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete the context from the current object
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # use activitystreams_new::{context, object::Video};
|
||||||
|
/// # let mut video = Video::default();
|
||||||
|
/// # video.set_context(context());
|
||||||
|
/// #
|
||||||
|
/// use activitystreams_new::prelude::*;
|
||||||
|
///
|
||||||
|
/// assert!(video.context().is_some());
|
||||||
|
/// video.delete_context();
|
||||||
|
/// assert!(video.context().is_none());
|
||||||
|
/// ```
|
||||||
fn delete_context(&mut self) -> &mut Self {
|
fn delete_context(&mut self) -> &mut Self {
|
||||||
self.base_mut().context = None;
|
self.base_mut().context = None;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Fetch the id for the current object
|
||||||
fn id<'a>(&'a self) -> Option<&'a XsdAnyUri>
|
fn id<'a>(&'a self) -> Option<&'a XsdAnyUri>
|
||||||
where
|
where
|
||||||
Kind: 'a,
|
Kind: 'a,
|
||||||
|
@ -76,20 +249,26 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self.base_ref().id.as_ref()
|
self.base_ref().id.as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set the id for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of id
|
||||||
fn set_id(&mut self, id: XsdAnyUri) -> &mut Self {
|
fn set_id(&mut self, id: XsdAnyUri) -> &mut Self {
|
||||||
self.base_mut().id = Some(id);
|
self.base_mut().id = Some(id);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take the id from the current object, leaving nothing
|
||||||
fn take_id(&mut self) -> Option<XsdAnyUri> {
|
fn take_id(&mut self) -> Option<XsdAnyUri> {
|
||||||
self.base_mut().id.take()
|
self.base_mut().id.take()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete the id from the current object
|
||||||
fn delete_id(&mut self) -> &mut Self {
|
fn delete_id(&mut self) -> &mut Self {
|
||||||
self.base_mut().id = None;
|
self.base_mut().id = None;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Fetch the kind for the current object
|
||||||
fn kind<'a>(&'a self) -> Option<&'a Kind>
|
fn kind<'a>(&'a self) -> Option<&'a Kind>
|
||||||
where
|
where
|
||||||
Kind: 'a,
|
Kind: 'a,
|
||||||
|
@ -97,20 +276,26 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self.base_ref().kind.as_ref()
|
self.base_ref().kind.as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set the kind for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of kind
|
||||||
fn set_kind(&mut self, kind: Kind) -> &mut Self {
|
fn set_kind(&mut self, kind: Kind) -> &mut Self {
|
||||||
self.base_mut().kind = Some(kind);
|
self.base_mut().kind = Some(kind);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take the kind from the current object, leaving nothing
|
||||||
fn take_kind(&mut self) -> Option<Kind> {
|
fn take_kind(&mut self) -> Option<Kind> {
|
||||||
self.base_mut().kind.take()
|
self.base_mut().kind.take()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete the kind from the current object
|
||||||
fn delete_kind(&mut self) -> &mut Self {
|
fn delete_kind(&mut self) -> &mut Self {
|
||||||
self.base_mut().kind = None;
|
self.base_mut().kind = None;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Fetch the name for the current object
|
||||||
fn name<'a>(&'a self) -> Option<&'a OneOrMany<AnyString>>
|
fn name<'a>(&'a self) -> Option<&'a OneOrMany<AnyString>>
|
||||||
where
|
where
|
||||||
Kind: 'a,
|
Kind: 'a,
|
||||||
|
@ -118,6 +303,9 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self.base_ref().name.as_ref()
|
self.base_ref().name.as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set the name for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of name
|
||||||
fn set_name<T>(&mut self, name: T) -> &mut Self
|
fn set_name<T>(&mut self, name: T) -> &mut Self
|
||||||
where
|
where
|
||||||
T: Into<AnyString>,
|
T: Into<AnyString>,
|
||||||
|
@ -126,6 +314,9 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set many names for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of name
|
||||||
fn set_many_names<I, T>(&mut self, items: I) -> &mut Self
|
fn set_many_names<I, T>(&mut self, items: I) -> &mut Self
|
||||||
where
|
where
|
||||||
I: IntoIterator<Item = T>,
|
I: IntoIterator<Item = T>,
|
||||||
|
@ -136,6 +327,9 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Add a name to the current object
|
||||||
|
///
|
||||||
|
/// This does not overwrite the contents of name, only appends a new item
|
||||||
fn add_name<T>(&mut self, name: T) -> &mut Self
|
fn add_name<T>(&mut self, name: T) -> &mut Self
|
||||||
where
|
where
|
||||||
T: Into<AnyString>,
|
T: Into<AnyString>,
|
||||||
|
@ -151,15 +345,18 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take the name from the current object, leaving nothing
|
||||||
fn take_name(&mut self) -> Option<OneOrMany<AnyString>> {
|
fn take_name(&mut self) -> Option<OneOrMany<AnyString>> {
|
||||||
self.base_mut().name.take()
|
self.base_mut().name.take()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete the name from the current object
|
||||||
fn delete_name(&mut self) -> &mut Self {
|
fn delete_name(&mut self) -> &mut Self {
|
||||||
self.base_mut().name = None;
|
self.base_mut().name = None;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Fetch the media type for the current object
|
||||||
fn media_type<'a>(&'a self) -> Option<&'a MimeMediaType>
|
fn media_type<'a>(&'a self) -> Option<&'a MimeMediaType>
|
||||||
where
|
where
|
||||||
Kind: 'a,
|
Kind: 'a,
|
||||||
|
@ -167,20 +364,26 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self.base_ref().media_type.as_ref()
|
self.base_ref().media_type.as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set the media type for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of media_type
|
||||||
fn set_media_type(&mut self, media_type: MimeMediaType) -> &mut Self {
|
fn set_media_type(&mut self, media_type: MimeMediaType) -> &mut Self {
|
||||||
self.base_mut().media_type = Some(media_type);
|
self.base_mut().media_type = Some(media_type);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take the media type from the current object, leaving nothing
|
||||||
fn take_media_type(&mut self) -> Option<MimeMediaType> {
|
fn take_media_type(&mut self) -> Option<MimeMediaType> {
|
||||||
self.base_mut().media_type.take()
|
self.base_mut().media_type.take()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete the media type from the current object
|
||||||
fn delete_media_type(&mut self) -> &mut Self {
|
fn delete_media_type(&mut self) -> &mut Self {
|
||||||
self.base_mut().media_type = None;
|
self.base_mut().media_type = None;
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Fetch the preview for the current object
|
||||||
fn preview<'a>(&'a self) -> Option<&'a OneOrMany<AnyBase>>
|
fn preview<'a>(&'a self) -> Option<&'a OneOrMany<AnyBase>>
|
||||||
where
|
where
|
||||||
Kind: 'a,
|
Kind: 'a,
|
||||||
|
@ -188,6 +391,9 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self.base_ref().preview.as_ref()
|
self.base_ref().preview.as_ref()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set the preview for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of preview
|
||||||
fn set_preview<T>(&mut self, preview: T) -> &mut Self
|
fn set_preview<T>(&mut self, preview: T) -> &mut Self
|
||||||
where
|
where
|
||||||
T: Into<AnyBase>,
|
T: Into<AnyBase>,
|
||||||
|
@ -196,6 +402,9 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Set many previews for the current object
|
||||||
|
///
|
||||||
|
/// This overwrites the contents of preview
|
||||||
fn set_many_previews<I, T>(&mut self, items: I) -> &mut Self
|
fn set_many_previews<I, T>(&mut self, items: I) -> &mut Self
|
||||||
where
|
where
|
||||||
I: IntoIterator<Item = T>,
|
I: IntoIterator<Item = T>,
|
||||||
|
@ -206,6 +415,9 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Add a preview to the current object
|
||||||
|
///
|
||||||
|
/// This does not overwrite the contents of preview, only appends an item
|
||||||
fn add_preview<T>(&mut self, preview: T) -> &mut Self
|
fn add_preview<T>(&mut self, preview: T) -> &mut Self
|
||||||
where
|
where
|
||||||
T: Into<AnyBase>,
|
T: Into<AnyBase>,
|
||||||
|
@ -221,10 +433,12 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take the preview from the current object, leaving nothing
|
||||||
fn take_preview(&mut self) -> Option<OneOrMany<AnyBase>> {
|
fn take_preview(&mut self) -> Option<OneOrMany<AnyBase>> {
|
||||||
self.base_mut().preview.take()
|
self.base_mut().preview.take()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Delete the preview from the current object
|
||||||
fn delete_preview(&mut self) -> &mut Self {
|
fn delete_preview(&mut self) -> &mut Self {
|
||||||
self.base_mut().preview = None;
|
self.base_mut().preview = None;
|
||||||
self
|
self
|
||||||
|
@ -235,45 +449,125 @@ pub trait BaseExt<Kind>: AsBase<Kind> {
|
||||||
#[serde(transparent)]
|
#[serde(transparent)]
|
||||||
struct IdOrBase(Either<XsdAnyUri, Box<Base<serde_json::Value>>>);
|
struct IdOrBase(Either<XsdAnyUri, Box<Base<serde_json::Value>>>);
|
||||||
|
|
||||||
|
/// A type that can represent Any ActivityStreams type
|
||||||
|
///
|
||||||
|
/// A type in activitystreams can be four things
|
||||||
|
/// - An Object
|
||||||
|
/// - A Link
|
||||||
|
/// - The ID of that Link or Object
|
||||||
|
/// - A string representing that Link or Object
|
||||||
#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
|
#[derive(Clone, Debug, serde::Deserialize, serde::Serialize)]
|
||||||
#[serde(transparent)]
|
#[serde(transparent)]
|
||||||
pub struct AnyBase(Either<IdOrBase, XsdString>);
|
pub struct AnyBase(Either<IdOrBase, XsdString>);
|
||||||
|
|
||||||
|
/// A representation of the common fields between Links and Objects in ActivityStreams
|
||||||
|
///
|
||||||
|
/// Although the spec does not define a type more abstract that Object or Link, it does define
|
||||||
|
/// fields present in both, so for the sake of "Everything derives from something," I've
|
||||||
|
/// implemented a type.
|
||||||
#[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize, TypedBuilder)]
|
#[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize, TypedBuilder)]
|
||||||
#[serde(rename_all = "camelCase")]
|
#[serde(rename_all = "camelCase")]
|
||||||
#[builder(doc)]
|
#[builder(doc)]
|
||||||
pub struct Base<Kind> {
|
pub struct Base<Kind> {
|
||||||
|
/// Identifies the context within which the object exists or an activity was performed.
|
||||||
|
///
|
||||||
|
/// The notion of "context"used is intentionally vague. The intended function is to serve as a
|
||||||
|
/// means of grouping objects and activities that share a common originating context or
|
||||||
|
/// purpose. An example could be all activities relating to a common project or event.
|
||||||
|
///
|
||||||
|
/// - Range: Object | Link
|
||||||
|
/// - Functional: false
|
||||||
|
#[serde(rename = "@context")]
|
||||||
|
#[serde(alias = "context")]
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
#[builder(default, setter(strip_option, into))]
|
#[builder(default, setter(strip_option, into))]
|
||||||
pub context: Option<OneOrMany<AnyBase>>,
|
pub context: Option<OneOrMany<AnyBase>>,
|
||||||
|
|
||||||
|
/// Provides the globally unique identifier for an Object or Link.
|
||||||
|
///
|
||||||
|
/// The id property is expressed as an absolute IRI in the spec, but for now is represented as
|
||||||
|
/// a string.
|
||||||
|
///
|
||||||
|
/// - Range: xsd:anyUri
|
||||||
|
/// - Functional: true
|
||||||
|
///
|
||||||
|
/// ### From ActivityStreams's deprecation notes
|
||||||
|
///
|
||||||
|
/// When processing Activity Streams 1.0 documents and converting those to 2.0, implementations
|
||||||
|
/// ought to treat id as an alias for the JSON-LD @id key word[.]
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
#[builder(default, setter(strip_option, into))]
|
#[builder(default, setter(strip_option, into))]
|
||||||
pub id: Option<XsdAnyUri>,
|
pub id: Option<XsdAnyUri>,
|
||||||
|
|
||||||
|
/// The `type` field
|
||||||
|
///
|
||||||
|
/// ### From JSON-LD's `type` documentation
|
||||||
|
///
|
||||||
|
/// This section is non-normative.
|
||||||
|
///
|
||||||
|
/// In Linked Data, it is common to specify the type of a graph node; in many cases, this can
|
||||||
|
/// be inferred based on the properties used within a given node object, or the property for
|
||||||
|
/// which a node is a value. For example, in the schema.org vocabulary, the givenName property
|
||||||
|
/// is associated with a Person. Therefore, one may reason that if a node object contains the
|
||||||
|
/// property givenName, that the type is a Person; making this explicit with @type helps to
|
||||||
|
/// clarify the association.
|
||||||
|
///
|
||||||
|
/// The type of a particular node can be specified using the @type keyword. In Linked Data,
|
||||||
|
/// types are uniquely identified with an IRI.
|
||||||
|
///
|
||||||
|
/// ### From ActivityStreams's deprecation notes
|
||||||
|
///
|
||||||
|
/// When processing Activity Streams 1.0 documents and converting those to 2.0, implementations
|
||||||
|
/// ought to treat [...] the objectType and verb properties as aliases for the JSON-LD @type
|
||||||
|
/// keyword.
|
||||||
#[serde(rename = "type")]
|
#[serde(rename = "type")]
|
||||||
|
#[serde(alias = "@type")]
|
||||||
|
#[serde(alias = "objectType")]
|
||||||
|
#[serde(alias = "verb")]
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
#[builder(default, setter(strip_option))]
|
#[builder(default, setter(strip_option))]
|
||||||
pub kind: Option<Kind>,
|
pub kind: Option<Kind>,
|
||||||
|
|
||||||
|
/// A simple, human-readable, plain-text name for the object.
|
||||||
|
///
|
||||||
|
/// HTML markup MUST NOT be included. The name MAY be expressed using multiple language-tagged values.
|
||||||
|
///
|
||||||
|
/// - Range: xsd:string | rdf:langString
|
||||||
|
/// - Functional: false
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
#[builder(default, setter(strip_option, into))]
|
#[builder(default, setter(strip_option, into))]
|
||||||
pub name: Option<OneOrMany<AnyString>>,
|
pub name: Option<OneOrMany<AnyString>>,
|
||||||
|
|
||||||
|
/// When used on an Object, identifies the MIME media type of the value of the content property.
|
||||||
|
///
|
||||||
|
/// If not specified, the content property is assumed to contain text/html content.
|
||||||
|
///
|
||||||
|
/// - Range: Mime Media Type
|
||||||
|
/// - Functional: true
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
#[builder(default, setter(strip_option))]
|
#[builder(default, setter(strip_option))]
|
||||||
pub media_type: Option<MimeMediaType>,
|
pub media_type: Option<MimeMediaType>,
|
||||||
|
|
||||||
|
/// Identifies an entity that provides a preview of this object.
|
||||||
|
///
|
||||||
|
/// - Range: Object | Link
|
||||||
|
/// - Functional: false
|
||||||
#[serde(skip_serializing_if = "Option::is_none")]
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
#[builder(default, setter(strip_option, into))]
|
#[builder(default, setter(strip_option, into))]
|
||||||
pub preview: Option<OneOrMany<AnyBase>>,
|
pub preview: Option<OneOrMany<AnyBase>>,
|
||||||
|
|
||||||
|
/// Any additional data present on the object if parsed from JSON
|
||||||
|
///
|
||||||
|
/// This is used to extend the Base into other kinds of objects and links
|
||||||
#[serde(flatten)]
|
#[serde(flatten)]
|
||||||
#[builder(default)]
|
#[builder(default)]
|
||||||
pub unparsed: Unparsed,
|
pub unparsed: Unparsed,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Base<serde_json::Value> {
|
impl Base<serde_json::Value> {
|
||||||
|
/// Convert this Base<serde_json::Value> into a Base<Kind>
|
||||||
|
///
|
||||||
|
/// This is required before extending Base into the other types found in this crate
|
||||||
pub fn solidify<Kind>(self) -> Result<Base<Kind>, serde_json::Error>
|
pub fn solidify<Kind>(self) -> Result<Base<Kind>, serde_json::Error>
|
||||||
where
|
where
|
||||||
Kind: serde::de::DeserializeOwned,
|
Kind: serde::de::DeserializeOwned,
|
||||||
|
@ -283,6 +577,18 @@ impl Base<serde_json::Value> {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<Kind> Base<Kind> {
|
impl<Kind> Base<Kind> {
|
||||||
|
/// Extend the Base into any other ActivityStreams type provided in this crate
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # fn main() -> Result<(), anyhow::Error> {
|
||||||
|
/// # use activitystreams_new::{base::Base, object::{Video, kind::VideoType}};
|
||||||
|
/// # let base = Base::<VideoType>::default();
|
||||||
|
/// #
|
||||||
|
/// let video = base.extend::<Video>()?;
|
||||||
|
/// #
|
||||||
|
/// # Ok(())
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
pub fn extend<T>(self) -> Result<T, T::Error>
|
pub fn extend<T>(self) -> Result<T, T::Error>
|
||||||
where
|
where
|
||||||
T: Extends<Kind>,
|
T: Extends<Kind>,
|
||||||
|
@ -290,6 +596,18 @@ impl<Kind> Base<Kind> {
|
||||||
T::extends(self)
|
T::extends(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Retract any other ActivityStreams type into a Base<Kind>
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// # fn main() -> Result<(), anyhow::Error> {
|
||||||
|
/// # use activitystreams_new::{base::Base, object::Video};
|
||||||
|
/// # let video = Video::default();
|
||||||
|
/// #
|
||||||
|
/// let base = Base::retract(video)?;
|
||||||
|
/// #
|
||||||
|
/// # Ok(())
|
||||||
|
/// # }
|
||||||
|
/// ```
|
||||||
pub fn retract<T>(t: T) -> Result<Self, T::Error>
|
pub fn retract<T>(t: T) -> Result<Self, T::Error>
|
||||||
where
|
where
|
||||||
T: Extends<Kind>,
|
T: Extends<Kind>,
|
||||||
|
@ -297,6 +615,9 @@ impl<Kind> Base<Kind> {
|
||||||
t.retracts()
|
t.retracts()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Convert this Base into a Base<serde_json::Value>
|
||||||
|
///
|
||||||
|
/// This is required before putting a Base into an AnyBase type
|
||||||
pub fn into_generic(self) -> Result<Base<serde_json::Value>, serde_json::Error>
|
pub fn into_generic(self) -> Result<Base<serde_json::Value>, serde_json::Error>
|
||||||
where
|
where
|
||||||
Kind: serde::ser::Serialize,
|
Kind: serde::ser::Serialize,
|
||||||
|
@ -304,6 +625,22 @@ impl<Kind> Base<Kind> {
|
||||||
self.try_map_kind(serde_json::to_value)
|
self.try_map_kind(serde_json::to_value)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// An inffalible conversion from Base<T> to Base<U> where there is a known path from T to U
|
||||||
|
///
|
||||||
|
/// ```rust
|
||||||
|
/// use activitystreams_new::{base::Base, prelude::*};
|
||||||
|
///
|
||||||
|
/// let mut base = Base::<String>::default();
|
||||||
|
/// base.set_kind("Hey".to_owned());
|
||||||
|
///
|
||||||
|
/// let new_base = base.map_kind(|kind| match kind.as_str() {
|
||||||
|
/// "Create" => 1,
|
||||||
|
/// "Update" => 5,
|
||||||
|
/// _ => 0,
|
||||||
|
/// });
|
||||||
|
///
|
||||||
|
/// assert!(*new_base.kind().unwrap() == 0);
|
||||||
|
/// ```
|
||||||
pub fn map_kind<NewKind>(self, f: impl Fn(Kind) -> NewKind) -> Base<NewKind> {
|
pub fn map_kind<NewKind>(self, f: impl Fn(Kind) -> NewKind) -> Base<NewKind> {
|
||||||
Base {
|
Base {
|
||||||
kind: self.kind.map(f),
|
kind: self.kind.map(f),
|
||||||
|
@ -316,6 +653,7 @@ impl<Kind> Base<Kind> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// A fallible conversion from Base<T> to Base<U>
|
||||||
pub fn try_map_kind<NewKind, E>(
|
pub fn try_map_kind<NewKind, E>(
|
||||||
self,
|
self,
|
||||||
f: impl Fn(Kind) -> Result<NewKind, E>,
|
f: impl Fn(Kind) -> Result<NewKind, E>,
|
||||||
|
@ -337,50 +675,107 @@ impl<Kind> Base<Kind> {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl AnyBase {
|
impl AnyBase {
|
||||||
|
/// Convert any type that is extended from Base<Kind> into an AnyBase for storing
|
||||||
|
pub fn from_extended<T, Kind>(extended: T) -> Result<Self, T::Error>
|
||||||
|
where
|
||||||
|
T: Extends<Kind>,
|
||||||
|
T::Error: From<serde_json::Error>,
|
||||||
|
Kind: serde::ser::Serialize,
|
||||||
|
{
|
||||||
|
Ok(Base::retract(extended)?.into_generic()?.into())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check if this object is an XsdAnyUri
|
||||||
|
pub fn is_xsd_any_uri(&self) -> bool {
|
||||||
|
self.0
|
||||||
|
.as_ref()
|
||||||
|
.left()
|
||||||
|
.and_then(|l| l.as_xsd_any_uri())
|
||||||
|
.is_some()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check if this object is an XsdString
|
||||||
|
pub fn is_xsd_string(&self) -> bool {
|
||||||
|
self.0.as_ref().right().is_some()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Check if this object is a Base<serde_json::Value>
|
||||||
|
pub fn is_base(&self) -> bool {
|
||||||
|
self.0.as_ref().left().and_then(|l| l.as_base()).is_some()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the id from the current object
|
||||||
|
///
|
||||||
|
/// This method checks if the current object _is_ an ID, and then falls back on the `id` field
|
||||||
|
/// within the `Base<serde_json::Value>` if that exists
|
||||||
|
pub fn id(&self) -> Option<&XsdAnyUri> {
|
||||||
|
self.as_xsd_any_uri()
|
||||||
|
.or_else(|| self.as_base().and_then(|base| base.id.as_ref()))
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the kind from the current object
|
||||||
|
///
|
||||||
|
/// This method only produces a value if the current object is a `Base<serde_json::Value>`
|
||||||
|
pub fn kind(&self) -> Option<&serde_json::Value> {
|
||||||
|
self.as_base().and_then(|base| base.kind.as_ref())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Get the object as an XsdAnyUri
|
||||||
pub fn as_xsd_any_uri(&self) -> Option<&XsdAnyUri> {
|
pub fn as_xsd_any_uri(&self) -> Option<&XsdAnyUri> {
|
||||||
self.0.as_ref().left().and_then(|l| l.as_xsd_any_uri())
|
self.0.as_ref().left().and_then(|l| l.as_xsd_any_uri())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Get the object as an XsdString
|
||||||
pub fn as_xsd_string(&self) -> Option<&XsdString> {
|
pub fn as_xsd_string(&self) -> Option<&XsdString> {
|
||||||
self.0.as_ref().right()
|
self.0.as_ref().right()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Get the object as a Base<serde_json::Value>
|
||||||
pub fn as_base(&self) -> Option<&Base<serde_json::Value>> {
|
pub fn as_base(&self) -> Option<&Base<serde_json::Value>> {
|
||||||
self.0.as_ref().left().and_then(|l| l.as_base())
|
self.0.as_ref().left().and_then(|l| l.as_base())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn id(self) -> Option<XsdAnyUri> {
|
/// Take the XsdAnyUri from the Object
|
||||||
|
pub fn take_xsd_any_uri(self) -> Option<XsdAnyUri> {
|
||||||
self.0.left().and_then(|l| l.id())
|
self.0.left().and_then(|l| l.id())
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn xsd_string(self) -> Option<XsdString> {
|
/// Take the XsdString from the Object
|
||||||
|
pub fn take_xsd_string(self) -> Option<XsdString> {
|
||||||
self.0.right()
|
self.0.right()
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn base(self) -> Option<Base<serde_json::Value>> {
|
/// Take the Base<serde_json::Value> from the Object
|
||||||
|
pub fn take_base(self) -> Option<Base<serde_json::Value>> {
|
||||||
self.0.left().and_then(|l| l.base())
|
self.0.left().and_then(|l| l.base())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Replace the object with the provided XsdAnyUri
|
||||||
pub fn set_xsd_any_uri(&mut self, id: XsdAnyUri) {
|
pub fn set_xsd_any_uri(&mut self, id: XsdAnyUri) {
|
||||||
self.0 = Either::Left(IdOrBase::from_xsd_any_uri(id));
|
self.0 = Either::Left(IdOrBase::from_xsd_any_uri(id));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Replace the object with the provided Base<serde_json::Value>
|
||||||
pub fn set_base(&mut self, base: Base<serde_json::Value>) {
|
pub fn set_base(&mut self, base: Base<serde_json::Value>) {
|
||||||
self.0 = Either::Left(IdOrBase::from_base(base));
|
self.0 = Either::Left(IdOrBase::from_base(base));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Replace the object with the provided XsdString
|
||||||
pub fn set_xsd_string(&mut self, xsd_string: XsdString) {
|
pub fn set_xsd_string(&mut self, xsd_string: XsdString) {
|
||||||
self.0 = Either::Right(xsd_string);
|
self.0 = Either::Right(xsd_string);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create an AnyBase from an XsdAnyUri
|
||||||
pub fn from_xsd_any_uri(id: XsdAnyUri) -> Self {
|
pub fn from_xsd_any_uri(id: XsdAnyUri) -> Self {
|
||||||
AnyBase(Either::Left(IdOrBase::from_xsd_any_uri(id)))
|
AnyBase(Either::Left(IdOrBase::from_xsd_any_uri(id)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create an AnyBase from a Base<serde_json::Value>
|
||||||
pub fn from_base(base: Base<serde_json::Value>) -> Self {
|
pub fn from_base(base: Base<serde_json::Value>) -> Self {
|
||||||
AnyBase(Either::Left(IdOrBase::from_base(base)))
|
AnyBase(Either::Left(IdOrBase::from_base(base)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create an AnyBase from an XsdString
|
||||||
pub fn from_xsd_string(xsd_string: XsdString) -> Self {
|
pub fn from_xsd_string(xsd_string: XsdString) -> Self {
|
||||||
AnyBase(Either::Right(xsd_string))
|
AnyBase(Either::Right(xsd_string))
|
||||||
}
|
}
|
||||||
|
@ -413,65 +808,80 @@ impl IdOrBase {
|
||||||
}
|
}
|
||||||
|
|
||||||
impl OneOrMany<AnyBase> {
|
impl OneOrMany<AnyBase> {
|
||||||
|
/// Get a single XsdAnyUri from the object, if that is what is contained
|
||||||
pub fn as_single_xsd_any_uri(&self) -> Option<&XsdAnyUri> {
|
pub fn as_single_xsd_any_uri(&self) -> Option<&XsdAnyUri> {
|
||||||
self.as_one().and_then(|inner| inner.as_xsd_any_uri())
|
self.as_one().and_then(|inner| inner.as_xsd_any_uri())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Get a single XsdString from the object, if that is what is contained
|
||||||
pub fn as_single_xsd_string(&self) -> Option<&XsdString> {
|
pub fn as_single_xsd_string(&self) -> Option<&XsdString> {
|
||||||
self.as_one().and_then(|inner| inner.as_xsd_string())
|
self.as_one().and_then(|inner| inner.as_xsd_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Get a single Base<serde_json::Value> from the object, if that is what is contained
|
||||||
pub fn as_single_base(&self) -> Option<&Base<serde_json::Value>> {
|
pub fn as_single_base(&self) -> Option<&Base<serde_json::Value>> {
|
||||||
self.as_one().and_then(|inner| inner.as_base())
|
self.as_one().and_then(|inner| inner.as_base())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take a single XsdAnyUri from the object, if that is what is contained
|
||||||
pub fn single_xsd_any_uri(self) -> Option<XsdAnyUri> {
|
pub fn single_xsd_any_uri(self) -> Option<XsdAnyUri> {
|
||||||
self.one().and_then(|inner| inner.id())
|
self.one().and_then(|inner| inner.take_xsd_any_uri())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take a single XsdString from the object, if that is what is contained
|
||||||
pub fn single_xsd_string(self) -> Option<XsdString> {
|
pub fn single_xsd_string(self) -> Option<XsdString> {
|
||||||
self.one().and_then(|inner| inner.xsd_string())
|
self.one().and_then(|inner| inner.take_xsd_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Take a single Base<serde_json::Value> from the object, if that is what is contained
|
||||||
pub fn single_base(self) -> Option<Base<serde_json::Value>> {
|
pub fn single_base(self) -> Option<Base<serde_json::Value>> {
|
||||||
self.one().and_then(|inner| inner.base())
|
self.one().and_then(|inner| inner.take_base())
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create a OneOrMany<AnyBase> from an XsdAnyUri
|
||||||
pub fn from_xsd_any_uri(id: XsdAnyUri) -> Self {
|
pub fn from_xsd_any_uri(id: XsdAnyUri) -> Self {
|
||||||
OneOrMany(Either::Left(AnyBase::from_xsd_any_uri(id)))
|
OneOrMany(Either::Left(AnyBase::from_xsd_any_uri(id)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create a OneOrMany<AnyBase> from an XsdString
|
||||||
pub fn from_xsd_string(xsd_string: XsdString) -> Self {
|
pub fn from_xsd_string(xsd_string: XsdString) -> Self {
|
||||||
OneOrMany(Either::Left(AnyBase::from_xsd_string(xsd_string)))
|
OneOrMany(Either::Left(AnyBase::from_xsd_string(xsd_string)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Create a OneOrMany<AnyBase> from a Base<serde_json::Value>
|
||||||
pub fn from_base(base: Base<serde_json::Value>) -> Self {
|
pub fn from_base(base: Base<serde_json::Value>) -> Self {
|
||||||
OneOrMany(Either::Left(AnyBase::from_base(base)))
|
OneOrMany(Either::Left(AnyBase::from_base(base)))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Overwrite the current object with an XsdAnyUri
|
||||||
pub fn set_single_xsd_any_uri(&mut self, id: XsdAnyUri) -> &mut Self {
|
pub fn set_single_xsd_any_uri(&mut self, id: XsdAnyUri) -> &mut Self {
|
||||||
self.0 = Either::Left(AnyBase::from_xsd_any_uri(id));
|
self.0 = Either::Left(AnyBase::from_xsd_any_uri(id));
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Overwrite the current object with an XsdString
|
||||||
pub fn set_single_xsd_string(&mut self, xsd_string: XsdString) -> &mut Self {
|
pub fn set_single_xsd_string(&mut self, xsd_string: XsdString) -> &mut Self {
|
||||||
self.0 = Either::Left(AnyBase::from_xsd_string(xsd_string));
|
self.0 = Either::Left(AnyBase::from_xsd_string(xsd_string));
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Overwrite the current object with a Base<serde_json::Value>
|
||||||
pub fn set_single_base(&mut self, base: Base<serde_json::Value>) -> &mut Self {
|
pub fn set_single_base(&mut self, base: Base<serde_json::Value>) -> &mut Self {
|
||||||
self.0 = Either::Left(AnyBase::from_base(base));
|
self.0 = Either::Left(AnyBase::from_base(base));
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Append an XsdAnyUri to the current object
|
||||||
pub fn add_xsd_any_uri(&mut self, id: XsdAnyUri) -> &mut Self {
|
pub fn add_xsd_any_uri(&mut self, id: XsdAnyUri) -> &mut Self {
|
||||||
self.add(AnyBase::from_xsd_any_uri(id))
|
self.add(AnyBase::from_xsd_any_uri(id))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Append an XsdString to the current object
|
||||||
pub fn add_xsd_string(&mut self, xsd_string: XsdString) -> &mut Self {
|
pub fn add_xsd_string(&mut self, xsd_string: XsdString) -> &mut Self {
|
||||||
self.add(AnyBase::from_xsd_string(xsd_string))
|
self.add(AnyBase::from_xsd_string(xsd_string))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Append a Base<serde_json::Value> to the current object
|
||||||
pub fn add_base(&mut self, base: Base<serde_json::Value>) -> &mut Self {
|
pub fn add_base(&mut self, base: Base<serde_json::Value>) -> &mut Self {
|
||||||
self.add(AnyBase::from_base(base))
|
self.add(AnyBase::from_base(base))
|
||||||
}
|
}
|
||||||
|
@ -495,6 +905,12 @@ impl<Kind> AsBase<Kind> for Base<Kind> {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<T, Kind> ExtendsExt<Kind> for T
|
||||||
|
where
|
||||||
|
T: Extends<Kind>,
|
||||||
|
T::Error: From<serde_json::Error>,
|
||||||
|
{
|
||||||
|
}
|
||||||
impl<T, Kind> BaseExt<Kind> for T where T: AsBase<Kind> {}
|
impl<T, Kind> BaseExt<Kind> for T where T: AsBase<Kind> {}
|
||||||
|
|
||||||
impl From<Base<serde_json::Value>> for AnyBase {
|
impl From<Base<serde_json::Value>> for AnyBase {
|
||||||
|
|
|
@ -23,7 +23,7 @@ pub mod prelude {
|
||||||
QuestionExt, TargetRefExt,
|
QuestionExt, TargetRefExt,
|
||||||
},
|
},
|
||||||
actor::ApActorExt,
|
actor::ApActorExt,
|
||||||
base::BaseExt,
|
base::{BaseExt, ExtendsExt},
|
||||||
collection::{CollectionExt, CollectionPageExt, OrderedCollectionPageExt},
|
collection::{CollectionExt, CollectionPageExt, OrderedCollectionPageExt},
|
||||||
link::LinkExt,
|
link::LinkExt,
|
||||||
object::{ApObjectExt, ObjectExt, PlaceExt, ProfileExt, RelationshipExt, TombstoneExt},
|
object::{ApObjectExt, ObjectExt, PlaceExt, ProfileExt, RelationshipExt, TombstoneExt},
|
||||||
|
|
|
@ -34,28 +34,28 @@ impl AnyString {
|
||||||
|
|
||||||
pub fn from_xsd_string<T>(string: T) -> Self
|
pub fn from_xsd_string<T>(string: T) -> Self
|
||||||
where
|
where
|
||||||
XsdString: From<T>,
|
T: Into<XsdString>,
|
||||||
{
|
{
|
||||||
AnyString(Either::Left(string.into()))
|
AnyString(Either::Left(string.into()))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn from_rdf_lang_string<T>(string: T) -> Self
|
pub fn from_rdf_lang_string<T>(string: T) -> Self
|
||||||
where
|
where
|
||||||
RdfLangString: From<T>,
|
T: Into<RdfLangString>,
|
||||||
{
|
{
|
||||||
AnyString(Either::Right(string.into()))
|
AnyString(Either::Right(string.into()))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set_xsd_string<T>(&mut self, string: T)
|
pub fn set_xsd_string<T>(&mut self, string: T)
|
||||||
where
|
where
|
||||||
XsdString: From<T>,
|
T: Into<XsdString>,
|
||||||
{
|
{
|
||||||
self.0 = Either::Left(string.into());
|
self.0 = Either::Left(string.into());
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn set_rdf_lang_string<T>(&mut self, string: T)
|
pub fn set_rdf_lang_string<T>(&mut self, string: T)
|
||||||
where
|
where
|
||||||
RdfLangString: From<T>,
|
T: Into<RdfLangString>,
|
||||||
{
|
{
|
||||||
self.0 = Either::Right(string.into());
|
self.0 = Either::Right(string.into());
|
||||||
}
|
}
|
||||||
|
@ -83,17 +83,31 @@ impl OneOrMany<AnyString> {
|
||||||
|
|
||||||
pub fn from_xsd_string<T>(string: T) -> Self
|
pub fn from_xsd_string<T>(string: T) -> Self
|
||||||
where
|
where
|
||||||
XsdString: From<T>,
|
T: Into<XsdString>,
|
||||||
{
|
{
|
||||||
Self::from_one(AnyString::from_xsd_string(string))
|
Self::from_one(AnyString::from_xsd_string(string))
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn from_rdf_lang_string<T>(string: T) -> Self
|
pub fn from_rdf_lang_string<T>(string: T) -> Self
|
||||||
where
|
where
|
||||||
RdfLangString: From<T>,
|
T: Into<RdfLangString>,
|
||||||
{
|
{
|
||||||
Self::from_one(AnyString::from_rdf_lang_string(string))
|
Self::from_one(AnyString::from_rdf_lang_string(string))
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn add_xsd_string<T>(&mut self, string: T) -> &mut Self
|
||||||
|
where
|
||||||
|
T: Into<XsdString>,
|
||||||
|
{
|
||||||
|
self.add(string.into())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn add_rdf_lang_string<T>(&mut self, string: T) -> &mut Self
|
||||||
|
where
|
||||||
|
T: Into<RdfLangString>,
|
||||||
|
{
|
||||||
|
self.add(string.into())
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> OneOrMany<T> {
|
impl<T> OneOrMany<T> {
|
||||||
|
@ -130,7 +144,7 @@ impl<T> OneOrMany<T> {
|
||||||
|
|
||||||
pub fn set_one<U>(&mut self, u: U) -> &mut Self
|
pub fn set_one<U>(&mut self, u: U) -> &mut Self
|
||||||
where
|
where
|
||||||
T: From<U>,
|
U: Into<T>,
|
||||||
{
|
{
|
||||||
self.0 = Either::Left(u.into());
|
self.0 = Either::Left(u.into());
|
||||||
self
|
self
|
||||||
|
@ -138,15 +152,15 @@ impl<T> OneOrMany<T> {
|
||||||
|
|
||||||
pub fn set_many<U>(&mut self, items: impl IntoIterator<Item = U>) -> &mut Self
|
pub fn set_many<U>(&mut self, items: impl IntoIterator<Item = U>) -> &mut Self
|
||||||
where
|
where
|
||||||
T: From<U>,
|
U: Into<T>,
|
||||||
{
|
{
|
||||||
self.0 = Either::Right(items.into_iter().map(T::from).collect());
|
self.0 = Either::Right(items.into_iter().map(Into::into).collect());
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn add<U>(&mut self, u: U) -> &mut Self
|
pub fn add<U>(&mut self, u: U) -> &mut Self
|
||||||
where
|
where
|
||||||
T: From<U>,
|
U: Into<T>,
|
||||||
{
|
{
|
||||||
let mut v = match std::mem::replace(&mut self.0, Either::Right(vec![])) {
|
let mut v = match std::mem::replace(&mut self.0, Either::Right(vec![])) {
|
||||||
Either::Left(one) => vec![one],
|
Either::Left(one) => vec![one],
|
||||||
|
@ -159,13 +173,13 @@ impl<T> OneOrMany<T> {
|
||||||
|
|
||||||
pub fn add_many<U>(&mut self, items: impl IntoIterator<Item = U>) -> &mut Self
|
pub fn add_many<U>(&mut self, items: impl IntoIterator<Item = U>) -> &mut Self
|
||||||
where
|
where
|
||||||
T: From<U>,
|
U: Into<T>,
|
||||||
{
|
{
|
||||||
let mut v = match std::mem::replace(&mut self.0, Either::Right(vec![])) {
|
let mut v = match std::mem::replace(&mut self.0, Either::Right(vec![])) {
|
||||||
Either::Left(one) => vec![one],
|
Either::Left(one) => vec![one],
|
||||||
Either::Right(v) => v,
|
Either::Right(v) => v,
|
||||||
};
|
};
|
||||||
v.extend(items.into_iter().map(T::from));
|
v.extend(items.into_iter().map(Into::into));
|
||||||
self.0 = Either::Right(v);
|
self.0 = Either::Right(v);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
|
@ -14,8 +14,12 @@ pub trait UnparsedMutExt: UnparsedMut {
|
||||||
where
|
where
|
||||||
T: serde::ser::Serialize,
|
T: serde::ser::Serialize,
|
||||||
{
|
{
|
||||||
self.unparsed_mut()
|
let value = serde_json::to_value(value)?;
|
||||||
.insert(key.to_owned(), serde_json::to_value(value)?);
|
|
||||||
|
if !value.is_null() {
|
||||||
|
self.unparsed_mut().insert(key.to_owned(), value);
|
||||||
|
}
|
||||||
|
|
||||||
Ok(self)
|
Ok(self)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue