Files
react-native/ReactCommon/react/renderer/imagemanager/ImageRequest.h
T
Samuel Susla 5fa6c5a941 Enable modernize-pass-by-value clang tidy rule
Summary:
changelog: [internal]

You can read more about this rule on https://clang.llvm.org/extra/clang-tidy/checks/modernize-pass-by-value.html

# Isn't it wasteful to copy? Isn't reference more efficient?

This rule of thumb is no longer true since C++11 with move semantics. Let's look at some examples.

# Option one

```
class TextHolder
{
public:
   TextBox(std::string const &text) : text_(text) {}
private:
   std::string text_;
};
```

By using reference here, we prevent the caller from using rvalue to and avoiding copy. Regardless of what the caller passes in, copy always happens.

# Option two

```
class TextHolder
{
public:
   TextBox(std::string const &text) : text_(text) {}
   TextBox(std::string &&text) : text_(std::move(text)) {}
private:
   std::string text_;
};
```
Here, we provide two constructors, one for const reference and one for rvalue reference. This gives the caller option to avoid copy. But now we have two constructors, which is not ideal.

# Option three (what we do in this diff)

```
class TextHolder
{
public:
   TextBox(std::string text) : text_(std::move(text)) {}
private:
   std::string text_;
};
```
Here, the caller has option to avoid copy and we only have single constructor.

Reviewed By: fkgozali, JoshuaGross

Differential Revision: D33276841

fbshipit-source-id: 619d5123d2e28937b22874650366629f24f20a63
2021-12-23 07:53:48 -08:00

101 lines
2.7 KiB
C++

/*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
#pragma once
#include <react/renderer/imagemanager/ImageResponse.h>
#include <react/renderer/imagemanager/ImageResponseObserver.h>
#include <react/renderer/imagemanager/ImageResponseObserverCoordinator.h>
#include <react/renderer/imagemanager/ImageTelemetry.h>
#include <react/renderer/imagemanager/primitives.h>
namespace facebook {
namespace react {
/*
* Represents ongoing request for an image resource.
* The separate object must be constructed for every single separate
* image request. The object cannot be copied because it would make managing of
* event listeners hard and inefficient; the object can be moved though.
* Destroy to cancel the underlying request.
*/
class ImageRequest final {
public:
/*
* The default constructor
*/
ImageRequest(
ImageSource imageSource,
std::shared_ptr<const ImageTelemetry> telemetry);
/*
* The move constructor.
*/
ImageRequest(ImageRequest &&other) noexcept;
/*
* `ImageRequest` does not support copying by design.
*/
ImageRequest(const ImageRequest &other) = delete;
~ImageRequest();
/**
* Set cancelation function.
*/
void setCancelationFunction(std::function<void(void)> cancelationFunction);
/*
* Returns the Image Source associated with the request.
*/
const ImageSource &getImageSource() const;
/*
* Returns stored observer coordinator as a shared pointer.
* Retain this *or* `ImageRequest` to ensure a correct lifetime of the object.
*/
const std::shared_ptr<const ImageResponseObserverCoordinator>
&getSharedObserverCoordinator() const;
/*
* Returns stored observer coordinator as a reference.
* Use this if a correct lifetime of the object is ensured in some other way
* (e.g. by retaining an `ImageRequest`).
*/
const ImageResponseObserverCoordinator &getObserverCoordinator() const;
/*
* Returns stored image telemetry object as a shared pointer.
* Retain this *or* `ImageRequest` to ensure a correct lifetime of the object.
*/
const std::shared_ptr<const ImageTelemetry> &getSharedTelemetry() const;
private:
/*
* Image source associated with the request.
*/
ImageSource imageSource_;
/*
* Image telemetry associated with the request.
*/
std::shared_ptr<const ImageTelemetry> telemetry_{};
/*
* Event coordinator associated with the reqest.
*/
std::shared_ptr<const ImageResponseObserverCoordinator> coordinator_{};
/*
* Function we can call to cancel image request (see destructor).
*/
std::function<void(void)> cancelRequest_;
};
} // namespace react
} // namespace facebook