ObjFW  Check-in [12b99a35c1]

Overview
Comment:Document more exceptions
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | trunk
Files: files | file ages | folders
SHA3-256: 12b99a35c13ac61803f2ef34e0329b7c42b8c5fd80295859321e20557b39e1ea
User & Date: js on 2022-09-23 21:53:02
Other Links: manifest | tags
Context
2022-09-24
15:32
Do not document exceptions that are obvious check-in: 96e0a91a06 user: js tags: trunk
2022-09-23
21:53
Document more exceptions check-in: 12b99a35c1 user: js tags: trunk
18:58
Update buildsys check-in: 06369eed8e user: js tags: trunk
Changes

Modified src/OFData+MessagePackParsing.h from [38e581e80e] to [48bbd2a0ec].

25
26
27
28
29
30
31







32
33
34
35
36
37
38
39
40






41
42
43
44
45
}
#endif

@interface OFData (MessagePackParsing)
/**
 * @brief The data interpreted as MessagePack representation and parsed as an
 *	  object.







 */
@property (readonly, nonatomic) id objectByParsingMessagePack;

/**
 * @brief Parses the MessagePack representation and returns it as an object.
 *
 * @param depthLimit The maximum depth the parser should accept (defaults to 32
 *		     if not specified, 0 means no limit (insecure!))
 * @return The MessagePack representation as an object






 */
- (id)objectByParsingMessagePackWithDepthLimit: (size_t)depthLimit;
@end

OF_ASSUME_NONNULL_END







>
>
>
>
>
>
>









>
>
>
>
>
>





25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
}
#endif

@interface OFData (MessagePackParsing)
/**
 * @brief The data interpreted as MessagePack representation and parsed as an
 *	  object.
 *
 * @throw OFInvalidFormatException The MessagePack representation contained in
 *				   the data contained an invalid format
 * @throw OFTruncatedDataException The MessagePack representation contained in
 *				   the data is truncated
 * @throw OFInvalidArgumentException The @ref itemSize of the data is not 1
 * @throw OFOutOfRangeException The depth limit has been exceeded
 */
@property (readonly, nonatomic) id objectByParsingMessagePack;

/**
 * @brief Parses the MessagePack representation and returns it as an object.
 *
 * @param depthLimit The maximum depth the parser should accept (defaults to 32
 *		     if not specified, 0 means no limit (insecure!))
 * @return The MessagePack representation as an object
 * @throw OFInvalidFormatException The MessagePack representation contained in
 *				   the data contained an invalid format
 * @throw OFTruncatedDataException The MessagePack representation contained in
 *				   the data is truncated
 * @throw OFInvalidArgumentException The @ref itemSize of the data is not 1
 * @throw OFOutOfRangeException The depth limit has been exceeded
 */
- (id)objectByParsingMessagePackWithDepthLimit: (size_t)depthLimit;
@end

OF_ASSUME_NONNULL_END