OFData.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2025 Jonathan Schleifer <js@nil.im>
 *
 * All rights reserved.
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3.0 only,
 * as published by the Free Software Foundation.
 *
 * 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 Lesser General Public License
 * version 3.0 for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3.0 along with this program. If not, see
 * <https://www.gnu.org/licenses/>.
 */
 
#import "OFObject.h"
#import "OFMessagePackRepresentation.h"

 
OF_ASSUME_NONNULL_BEGIN
 
@class OFIRI;
@class OFString;

typedef enum {
    OFDataSearchBackwards = 1
} OFDataSearchOptions;

@interface OFData: OFObject <OFCopying, OFMutableCopying, OFComparing,
    OFMessagePackRepresentation>
@property (readonly, nonatomic) size_t itemSize;

@property (readonly, nonatomic) size_t count;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) const void *items
    OF_RETURNS_INNER_POINTER;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) const void *firstItem
    OF_RETURNS_INNER_POINTER;

@property OF_NULLABLE_PROPERTY (readonly, nonatomic) const void *lastItem
    OF_RETURNS_INNER_POINTER;

@property (readonly, nonatomic) OFString *stringRepresentation;

@property (readonly, nonatomic) OFString *stringByBase64Encoding;

+ (instancetype)data;

+ (instancetype)dataWithItemSize: (size_t)itemSize;

+ (instancetype)dataWithItems: (const void *)items count: (size_t)count;

+ (instancetype)dataWithItems: (const void *)items
            count: (size_t)count
             itemSize: (size_t)itemSize;

+ (instancetype)dataWithItemsNoCopy: (void *)items
                  count: (size_t)count
               freeWhenDone: (bool)freeWhenDone;

+ (instancetype)dataWithItemsNoCopy: (void *)items
                  count: (size_t)count
               itemSize: (size_t)itemSize
               freeWhenDone: (bool)freeWhenDone;
 
#ifdef OF_HAVE_FILES
+ (instancetype)dataWithContentsOfFile: (OFString *)path;
#endif

+ (instancetype)dataWithContentsOfIRI: (OFIRI *)IRI;

+ (instancetype)dataWithStringRepresentation: (OFString *)string;

+ (instancetype)dataWithBase64EncodedString: (OFString *)string;

- (instancetype)init;

- (instancetype)initWithItemSize: (size_t)itemSize;

- (instancetype)initWithItems: (const void *)items count: (size_t)count;

- (instancetype)initWithItems: (const void *)items
            count: (size_t)count
             itemSize: (size_t)itemSize;

- (instancetype)initWithItemsNoCopy: (void *)items
                  count: (size_t)count
               freeWhenDone: (bool)freeWhenDone;

- (instancetype)initWithItemsNoCopy: (void *)items
                  count: (size_t)count
               itemSize: (size_t)itemSize
               freeWhenDone: (bool)freeWhenDone;
 
#ifdef OF_HAVE_FILES
- (instancetype)initWithContentsOfFile: (OFString *)path;
#endif

- (instancetype)initWithContentsOfIRI: (OFIRI *)IRI;

- (instancetype)initWithStringRepresentation: (OFString *)string;

- (instancetype)initWithBase64EncodedString: (OFString *)string;

- (OFComparisonResult)compare: (OFData *)data;

- (const void *)itemAtIndex: (size_t)index OF_RETURNS_INNER_POINTER;

- (OFData *)subdataWithRange: (OFRange)range;

- (OFRange)rangeOfData: (OFData *)data
           options: (OFDataSearchOptions)options
         range: (OFRange)range;
 
#ifdef OF_HAVE_FILES
- (void)writeToFile: (OFString *)path;
#endif

- (void)writeToIRI: (OFIRI *)IRI;
@end
 
OF_ASSUME_NONNULL_END
 
#import "OFMutableData.h"
#import "OFData+CryptographicHashing.h"
#import "OFData+MessagePackParsing.h"