OFData.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017
 *   Jonathan Schleifer <js@heap.zone>
 *
 * All rights reserved.
 *
 * This file is part of ObjFW. It may be distributed under the terms of the
 * Q Public License 1.0, which can be found in the file LICENSE.QPL included in
 * the packaging of this file.
 *
 * Alternatively, it may be distributed under the terms of the GNU General
 * Public License, either version 2 or 3, which can be found in the file
 * LICENSE.GPLv2 or LICENSE.GPLv3 respectively included in the packaging of this
 * file.
 */

#import "OFObject.h"
#import "OFSerialization.h"
#import "OFMessagePackRepresentation.h"

OF_ASSUME_NONNULL_BEGIN

@class OFString;
@class OFURL;

@interface OFData: OFObject <OFCopying, OFMutableCopying, OFComparing,
    OFSerialization, OFMessagePackRepresentation>
{
    unsigned char *_items;
    size_t _count, _itemSize;
    bool _freeWhenDone;
}

@property (readonly, nonatomic) size_t itemSize;

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

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

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

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

#ifdef OF_HAVE_FILES

+ (instancetype)dataWithContentsOfFile: (OFString *)path;
#endif

#if defined(OF_HAVE_FILES) || defined(OF_HAVE_SOCKETS)

+ (instancetype)dataWithContentsOfURL: (OFURL *)URL;
#endif

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

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

- init OF_UNAVAILABLE;

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

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

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

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

#ifdef OF_HAVE_FILES

- initWithContentsOfFile: (OFString *)path;
#endif

#if defined(OF_HAVE_FILES) || defined(OF_HAVE_SOCKETS)

- initWithContentsOfURL: (OFURL *)URL;
#endif

- initWithStringRepresentation: (OFString *)string;

- initWithBase64EncodedString: (OFString *)string;

- (size_t)count;

- (const void *)items OF_RETURNS_INNER_POINTER;

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

- (nullable const void *)firstItem OF_RETURNS_INNER_POINTER;

- (nullable const void *)lastItem OF_RETURNS_INNER_POINTER;

- (OFString *)stringRepresentation;

- (OFString *)stringByBase64Encoding;

#ifdef OF_HAVE_FILES

- (void)writeToFile: (OFString *)path;
#endif
@end

OF_ASSUME_NONNULL_END

#import "OFMutableData.h"
#import "OFData+CryptoHashing.h"
#import "OFData+MessagePackValue.h"