near_sdk/near_annotations.rs
1//! `#[near]` and `#[near_bindgen]` documentation module
2//!
3//! This is not a real module; here we document the attributes that [`#[near]`](crate::near)
4//! and [`#[near_bindgen]`](crate::near_bindgen) macro use.
5//!
6//! `near_bindgen` and `near_sdk` share most of the attributes:
7//! * `init`
8//! * `payable`
9//! * `private`
10//! * `deny_unknown_arguments`
11//! * `handle_result`
12//! * `callback_unwrap`
13//! * `callback_result`
14//! * `callback_vec`
15//! * `event_json`
16//! * `contract_metadata`
17//! * `serializer`
18//! * `result_serializer`
19//!
20//! Following attributes are only part of the `near` macro:
21//! * `serializers`
22//! * `contract_state`
23
24/// See [`near_sdk::near #[init]`](crate::near#init-annotates-methods-of-a-type-in-its-impl-block)
25pub fn init() {}
26
27/// See [`near_sdk::near #[payable]`](crate::near#payable-annotates-methods-of-a-type-in-its-impl-block)
28pub fn payable() {}
29
30/// See [`near_sdk::near #[private]`](crate::near#private-annotates-methods-of-a-type-in-its-impl-block)
31pub fn private() {}
32
33/// See [`near_sdk::near #[deny_unknown_arguments]`](crate::near#deny_unknown_arguments-annotates-methods-of-a-type-in-its-impl-block)
34pub fn deny_unknown_arguments() {}
35
36/// See [`near_sdk::near #[result_serializer]`](crate::near#result_serializer-annotates-methods-of-a-type-in-its-impl-block)
37pub fn result_serializer() {}
38
39/// See [`near_sdk::near #[handle_result]`](crate::near#handle_result-annotates-methods-of-a-type-in-its-impl-block)
40pub fn handle_result() {}
41
42/// See [`near_sdk::near #[callback_unwrap]`](crate::near#callback_unwrap-annotates-function-arguments)
43pub fn callback_unwrap() {}
44
45/// See [`near_sdk::near #[callback_result]`](crate::near#callback_result-annotates-function-arguments)
46pub fn callback_result() {}
47
48/// See [`near_sdk::near #[callback_vec]`](crate::near#callback_vec-annotates-function-arguments)
49pub fn callback_vec() {}
50
51/// See [`near_sdk::near #[near(event_json(...))]`](crate::near#nearevent_json-annotates-enums)
52pub fn event_json() {}
53
54/// See [`near_sdk::near #[near(contract_metadata(...))]`](crate::near#nearcontract_metadata-annotates-structsenums)
55pub fn contract_metadata() {}
56
57/// See [`near_sdk::near #[serializer(...)]`](crate::near#serializer-annotates-function-arguments)
58pub fn serializer() {}
59
60/// See [`near_sdk::near #[near(serializers=[...])]`](crate::near#nearserializers-annotates-structsenums)
61pub fn serializers() {}
62
63/// See [`near_sdk::near #[near(contract_state)]`](crate::near#nearcontract_state-annotates-structsenums)
64pub fn contract_state() {}